1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076 |
- <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
- <!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- -->
- <!-- Generated by the JDiff Javadoc doclet -->
- <!-- (http://www.jdiff.org) -->
- <!-- on Wed Apr 08 11:29:43 PDT 2015 -->
- <api
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:noNamespaceSchemaLocation='api.xsd'
- name="hadoop-yarn-api 2.6.0"
- jdversion="1.0.9">
- <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet -docletpath /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/Users/llu/.m2/repository/commons-lang/commons-lang/2.6/commons-lang-2.6.jar:/Users/llu/.m2/repository/com/google/guava/guava/11.0.2/guava-11.0.2.jar:/Users/llu/.m2/repository/com/google/code/findbugs/jsr305/1.3.9/jsr305-1.3.9.jar:/Users/llu/.m2/repository/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/Users/llu/.m2/repository/org/apache/hadoop/hadoop-common/2.6.0/hadoop-common-2.6.0.jar:/Users/llu/.m2/repository/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/Users/llu/.m2/repository/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/Users/llu/.m2/repository/xmlenc/xmlenc/0.52/xmlenc-0.52.jar:/Users/llu/.m2/repository/commons-httpclient/commons-httpclient/3.1/commons-httpclient-3.1.jar:/Users/llu/.m2/repository/commons-codec/commons-codec/1.4/commons-codec-1.4.jar:/Users/llu/.m2/repository/commons-io/commons-io/2.4/commons-io-2.4.jar:/Users/llu/.m2/repository/commons-net/commons-net/3.1/commons-net-3.1.jar:/Users/llu/.m2/repository/commons-collections/commons-collections/3.2.1/commons-collections-3.2.1.jar:/Users/llu/.m2/repository/javax/servlet/servlet-api/2.5/servlet-api-2.5.jar:/Users/llu/.m2/repository/org/mortbay/jetty/jetty/6.1.26/jetty-6.1.26.jar:/Users/llu/.m2/repository/org/mortbay/jetty/jetty-util/6.1.26/jetty-util-6.1.26.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-core/1.9/jersey-core-1.9.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-json/1.9/jersey-json-1.9.jar:/Users/llu/.m2/repository/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/Users/llu/.m2/repository/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/Users/llu/.m2/repository/javax/xml/bind/jaxb-api/2.2.2/jaxb-api-2.2.2.jar:/Users/llu/.m2/repository/javax/xml/stream/stax-api/1.0-2/stax-api-1.0-2.jar:/Users/llu/.m2/repository/javax/activation/activation/1.1/activation-1.1.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/Users/llu/.m2/repository/com/sun/jersey/jersey-server/1.9/jersey-server-1.9.jar:/Users/llu/.m2/repository/asm/asm/3.2/asm-3.2.jar:/Users/llu/.m2/repository/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/Users/llu/.m2/repository/log4j/log4j/1.2.17/log4j-1.2.17.jar:/Users/llu/.m2/repository/net/java/dev/jets3t/jets3t/0.9.0/jets3t-0.9.0.jar:/Users/llu/.m2/repository/org/apache/httpcomponents/httpclient/4.2.5/httpclient-4.2.5.jar:/Users/llu/.m2/repository/org/apache/httpcomponents/httpcore/4.2.5/httpcore-4.2.5.jar:/Users/llu/.m2/repository/com/jamesmurty/utils/java-xmlbuilder/0.4/java-xmlbuilder-0.4.jar:/Users/llu/.m2/repository/commons-configuration/commons-configuration/1.6/commons-configuration-1.6.jar:/Users/llu/.m2/repository/commons-digester/commons-digester/1.8/commons-digester-1.8.jar:/Users/llu/.m2/repository/commons-beanutils/commons-beanutils/1.7.0/commons-beanutils-1.7.0.jar:/Users/llu/.m2/repository/commons-beanutils/commons-beanutils-core/1.8.0/commons-beanutils-core-1.8.0.jar:/Users/llu/.m2/repository/org/slf4j/slf4j-api/1.7.5/slf4j-api-1.7.5.jar:/Users/llu/.m2/repository/org/slf4j/slf4j-log4j12/1.7.5/slf4j-log4j12-1.7.5.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/Users/llu/.m2/repository/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/Users/llu/.m2/repository/org/apache/avro/avro/1.7.4/avro-1.7.4.jar:/Users/llu/.m2/repository/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/Users/llu/.m2/repository/org/xerial/snappy/snappy-java/1.0.4.1/snappy-java-1.0.4.1.jar:/Users/llu/.m2/repository/com/google/code/gson/gson/2.2.4/gson-2.2.4.jar:/Users/llu/.m2/repository/org/apache/hadoop/hadoop-auth/2.6.0/hadoop-auth-2.6.0.jar:/Users/llu/.m2/repository/org/apache/directory/server/apacheds-kerberos-codec/2.0.0-M15/apacheds-kerberos-codec-2.0.0-M15.jar:/Users/llu/.m2/repository/org/apache/directory/server/apacheds-i18n/2.0.0-M15/apacheds-i18n-2.0.0-M15.jar:/Users/llu/.m2/repository/org/apache/directory/api/api-asn1-api/1.0.0-M20/api-asn1-api-1.0.0-M20.jar:/Users/llu/.m2/repository/org/apache/directory/api/api-util/1.0.0-M20/api-util-1.0.0-M20.jar:/Users/llu/.m2/repository/org/apache/curator/curator-framework/2.6.0/curator-framework-2.6.0.jar:/Users/llu/.m2/repository/com/jcraft/jsch/0.1.42/jsch-0.1.42.jar:/Users/llu/.m2/repository/org/apache/curator/curator-client/2.6.0/curator-client-2.6.0.jar:/Users/llu/.m2/repository/org/apache/curator/curator-recipes/2.6.0/curator-recipes-2.6.0.jar:/Users/llu/.m2/repository/org/htrace/htrace-core/3.0.4/htrace-core-3.0.4.jar:/Users/llu/.m2/repository/org/apache/zookeeper/zookeeper/3.4.6/zookeeper-3.4.6.jar:/Users/llu/.m2/repository/io/netty/netty/3.6.2.Final/netty-3.6.2.Final.jar:/Users/llu/.m2/repository/org/apache/commons/commons-compress/1.4.1/commons-compress-1.4.1.jar:/Users/llu/.m2/repository/org/tukaani/xz/1.0/xz-1.0.jar:/Users/llu/.m2/repository/org/apache/hadoop/hadoop-annotations/2.6.0/hadoop-annotations-2.6.0.jar:/Library/Java/JavaVirtualMachines/jdk1.7.0_67.jdk/Contents/Home/lib/tools.jar:/Users/llu/.m2/repository/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar -sourcepath /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -apidir /Users/llu/hadoop2_6/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname hadoop-yarn-api 2.6.0 -->
- <package name="org.apache.hadoop.yarn.api">
- <!-- start interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
- <interface name="ApplicationClientProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to obtain a new {@link ApplicationId} for
- submitting new applications.</p>
- <p>The <code>ResourceManager</code> responds with a new, monotonically
- increasing, {@link ApplicationId} which is used by the client to submit
- a new application.</p>
- <p>The <code>ResourceManager</code> also responds with details such
- as maximum resource capabilities in the cluster as specified in
- {@link GetNewApplicationResponse}.</p>
- @param request request to get a new <code>ApplicationId</code>
- @return response containing the new <code>ApplicationId</code> to be used
- to submit an application
- @throws YarnException
- @throws IOException
- @see #submitApplication(SubmitApplicationRequest)]]>
- </doc>
- </method>
- <method name="submitApplication" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to submit a new application to the
- <code>ResourceManager.</code></p>
- <p>The client is required to provide details such as queue,
- {@link Resource} required to run the <code>ApplicationMaster</code>,
- the equivalent of {@link ContainerLaunchContext} for launching
- the <code>ApplicationMaster</code> etc. via the
- {@link SubmitApplicationRequest}.</p>
- <p>Currently the <code>ResourceManager</code> sends an immediate (empty)
- {@link SubmitApplicationResponse} on accepting the submission and throws
- an exception if it rejects the submission. However, this call needs to be
- followed by {@link #getApplicationReport(GetApplicationReportRequest)}
- to make sure that the application gets properly submitted - obtaining a
- {@link SubmitApplicationResponse} from ResourceManager doesn't guarantee
- that RM 'remembers' this application beyond failover or restart. If RM
- failover or RM restart happens before ResourceManager saves the
- application's state successfully, the subsequent
- {@link #getApplicationReport(GetApplicationReportRequest)} will throw
- a {@link ApplicationNotFoundException}. The Clients need to re-submit
- the application with the same {@link ApplicationSubmissionContext} when
- it encounters the {@link ApplicationNotFoundException} on the
- {@link #getApplicationReport(GetApplicationReportRequest)} call.</p>
- <p>During the submission process, it checks whether the application
- already exists. If the application exists, it will simply return
- SubmitApplicationResponse</p>
- <p> In secure mode,the <code>ResourceManager</code> verifies access to
- queues etc. before accepting the application submission.</p>
- @param request request to submit a new application
- @return (empty) response on accepting the submission
- @throws YarnException
- @throws IOException
- @throws InvalidResourceRequestException
- The exception is thrown when a {@link ResourceRequest} is out of
- the range of the configured lower and upper resource boundaries.
- @see #getNewApplication(GetNewApplicationRequest)]]>
- </doc>
- </method>
- <method name="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to request the
- <code>ResourceManager</code> to abort submitted application.</p>
- <p>The client, via {@link KillApplicationRequest} provides the
- {@link ApplicationId} of the application to be aborted.</p>
- <p> In secure mode,the <code>ResourceManager</code> verifies access to the
- application, queue etc. before terminating the application.</p>
- <p>Currently, the <code>ResourceManager</code> returns an empty response
- on success and throws an exception on rejecting the request.</p>
- @param request request to abort a submitted application
- @return <code>ResourceManager</code> returns an empty response
- on success and throws an exception on rejecting the request
- @throws YarnException
- @throws IOException
- @see #getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
- </doc>
- </method>
- <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get a report of an Application from
- the <code>ResourceManager</code>.</p>
- <p>The client, via {@link GetApplicationReportRequest} provides the
- {@link ApplicationId} of the application.</p>
- <p> In secure mode,the <code>ResourceManager</code> verifies access to the
- application, queue etc. before accepting the request.</p>
- <p>The <code>ResourceManager</code> responds with a
- {@link GetApplicationReportResponse} which includes the
- {@link ApplicationReport} for the application.</p>
- <p>If the user does not have <code>VIEW_APP</code> access then the
- following fields in the report will be set to stubbed values:
- <ul>
- <li>host - set to "N/A"</li>
- <li>RPC port - set to -1</li>
- <li>client token - set to "N/A"</li>
- <li>diagnostics - set to "N/A"</li>
- <li>tracking URL - set to "N/A"</li>
- <li>original tracking URL - set to "N/A"</li>
- <li>resource usage report - all values are -1</li>
- </ul></p>
- @param request request for an application report
- @return application report
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get metrics about the cluster from
- the <code>ResourceManager</code>.</p>
- <p>The <code>ResourceManager</code> responds with a
- {@link GetClusterMetricsResponse} which includes the
- {@link YarnClusterMetrics} with details such as number of current
- nodes in the cluster.</p>
- @param request request for cluster metrics
- @return cluster metrics
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getApplications" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get a report of Applications
- matching the filters defined by {@link GetApplicationsRequest}
- in the cluster from the <code>ResourceManager</code>.</p>
- <p>The <code>ResourceManager</code> responds with a
- {@link GetApplicationsResponse} which includes the
- {@link ApplicationReport} for the applications.</p>
- <p>If the user does not have <code>VIEW_APP</code> access for an
- application then the corresponding report will be filtered as
- described in {@link #getApplicationReport(GetApplicationReportRequest)}.
- </p>
- @param request request for report on applications
- @return report on applications matching the given application types
- defined in the request
- @throws YarnException
- @throws IOException
- @see GetApplicationsRequest]]>
- </doc>
- </method>
- <method name="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get a report of all nodes
- in the cluster from the <code>ResourceManager</code>.</p>
- <p>The <code>ResourceManager</code> responds with a
- {@link GetClusterNodesResponse} which includes the
- {@link NodeReport} for all the nodes in the cluster.</p>
- @param request request for report on all nodes
- @return report on all nodes
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get information about <em>queues</em>
- from the <code>ResourceManager</code>.</p>
- <p>The client, via {@link GetQueueInfoRequest}, can ask for details such
- as used/total resources, child queues, running applications etc.</p>
- <p> In secure mode,the <code>ResourceManager</code> verifies access before
- providing the information.</p>
- @param request request to get queue information
- @return queue information
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getQueueUserAcls" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get information about <em>queue
- acls</em> for <em>current user</em> from the <code>ResourceManager</code>.
- </p>
- <p>The <code>ResourceManager</code> responds with queue acls for all
- existing queues.</p>
- @param request request to get queue acls for <em>current user</em>
- @return queue acls for <em>current user</em>
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by clients to get delegation token, enabling the
- containers to be able to talk to the service using those tokens.
- <p> The <code>ResourceManager</code> responds with the delegation
- {@link Token} that can be used by the client to speak to this
- service.
- @param request request to get a delegation token for the client.
- @return delegation token that can be used to talk to this service
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Move an application to a new queue.
- @param request the application ID and the target queue
- @return an empty response
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of an Application Attempt
- from the <code>ResourceManager</code>
- </p>
- <p>
- The client, via {@link GetApplicationAttemptReportRequest} provides the
- {@link ApplicationAttemptId} of the application attempt.
- </p>
- <p>
- In secure mode,the <code>ResourceManager</code> verifies access to
- the method before accepting the request.
- </p>
- <p>
- The <code>ResourceManager</code> responds with a
- {@link GetApplicationAttemptReportResponse} which includes the
- {@link ApplicationAttemptReport} for the application attempt.
- </p>
- <p>
- If the user does not have <code>VIEW_APP</code> access then the following
- fields in the report will be set to stubbed values:
- <ul>
- <li>host</li>
- <li>RPC port</li>
- <li>client token</li>
- <li>diagnostics - set to "N/A"</li>
- <li>tracking URL</li>
- </ul>
- </p>
- @param request
- request for an application attempt report
- @return application attempt report
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getApplicationAttempts" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of all Application attempts
- in the cluster from the <code>ResourceManager</code>
- </p>
- <p>
- The <code>ResourceManager</code> responds with a
- {@link GetApplicationAttemptsRequest} which includes the
- {@link ApplicationAttemptReport} for all the applications attempts of a
- specified application attempt.
- </p>
- <p>
- If the user does not have <code>VIEW_APP</code> access for an application
- then the corresponding report will be filtered as described in
- {@link #getApplicationAttemptReport(GetApplicationAttemptReportRequest)}.
- </p>
- @param request
- request for reports on all application attempts of an application
- @return reports on all application attempts of an application
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getContainerReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of an Container from the
- <code>ResourceManager</code>
- </p>
- <p>
- The client, via {@link GetContainerReportRequest} provides the
- {@link ContainerId} of the container.
- </p>
- <p>
- In secure mode,the <code>ResourceManager</code> verifies access to the
- method before accepting the request.
- </p>
- <p>
- The <code>ResourceManager</code> responds with a
- {@link GetContainerReportResponse} which includes the
- {@link ContainerReport} for the container.
- </p>
- @param request
- request for a container report
- @return container report
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getContainers" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of Containers for an
- application attempt from the <code>ResourceManager</code>
- </p>
- <p>
- The client, via {@link GetContainersRequest} provides the
- {@link ApplicationAttemptId} of the application attempt.
- </p>
- <p>
- In secure mode,the <code>ResourceManager</code> verifies access to the
- method before accepting the request.
- </p>
- <p>
- The <code>ResourceManager</code> responds with a
- {@link GetContainersResponse} which includes a list of
- {@link ContainerReport} for all the containers of a specific application
- attempt.
- </p>
- @param request
- request for a list of container reports of an application attempt.
- @return reports on all containers of an application attempt
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to submit a new reservation to the
- {@code ResourceManager}.
- </p>
- <p>
- The client packages all details of its request in a
- {@link ReservationSubmissionRequest} object. This contains information
- about the amount of capacity, temporal constraints, and concurrency needs.
- Furthermore, the reservation might be composed of multiple stages, with
- ordering dependencies among them.
- </p>
- <p>
- In order to respond, a new admission control component in the
- {@code ResourceManager} performs an analysis of the resources that have
- been committed over the period of time the user is requesting, verify that
- the user requests can be fulfilled, and that it respect a sharing policy
- (e.g., {@code CapacityOverTimePolicy}). Once it has positively determined
- that the ReservationSubmissionRequest is satisfiable the
- {@code ResourceManager} answers with a
- {@link ReservationSubmissionResponse} that include a non-null
- {@link ReservationId}. Upon failure to find a valid allocation the response
- is an exception with the reason.
- On application submission the client can use this {@link ReservationId} to
- obtain access to the reserved resources.
- </p>
- <p>
- The system guarantees that during the time-range specified by the user, the
- reservationID will be corresponding to a valid reservation. The amount of
- capacity dedicated to such queue can vary overtime, depending of the
- allocation that has been determined. But it is guaranteed to satisfy all
- the constraint expressed by the user in the
- {@link ReservationSubmissionRequest}.
- </p>
- @param request the request to submit a new Reservation
- @return response the {@link ReservationId} on accepting the submission
- @throws YarnException if the request is invalid or reservation cannot be
- created successfully
- @throws IOException]]>
- </doc>
- </method>
- <method name="updateReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to update an existing Reservation. This is
- referred to as a re-negotiation process, in which a user that has
- previously submitted a Reservation.
- </p>
- <p>
- The allocation is attempted by virtually substituting all previous
- allocations related to this Reservation with new ones, that satisfy the new
- {@link ReservationUpdateRequest}. Upon success the previous allocation is
- substituted by the new one, and on failure (i.e., if the system cannot find
- a valid allocation for the updated request), the previous allocation
- remains valid.
- The {@link ReservationId} is not changed, and applications currently
- running within this reservation will automatically receive the resources
- based on the new allocation.
- </p>
- @param request to update an existing Reservation (the ReservationRequest
- should refer to an existing valid {@link ReservationId})
- @return response empty on successfully updating the existing reservation
- @throws YarnException if the request is invalid or reservation cannot be
- updated successfully
- @throws IOException]]>
- </doc>
- </method>
- <method name="deleteReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to remove an existing Reservation.
- Upon deletion of a reservation applications running with this reservation,
- are automatically downgraded to normal jobs running without any dedicated
- reservation.
- </p>
- @param request to remove an existing Reservation (the ReservationRequest
- should refer to an existing valid {@link ReservationId})
- @return response empty on successfully deleting the existing reservation
- @throws YarnException if the request is invalid or reservation cannot be
- deleted successfully
- @throws IOException]]>
- </doc>
- </method>
- <method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by client to get node to labels mappings in existing cluster
- </p>
- @param request
- @return node to labels mappings
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by client to get node labels in the cluster
- </p>
- @param request to get node labels collection of this cluster
- @return node labels collection of this cluster
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The protocol between clients and the <code>ResourceManager</code>
- to submit/abort jobs and to get information on applications, cluster metrics,
- nodes, queues and ACLs.</p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ApplicationClientProtocol -->
- <!-- start interface org.apache.hadoop.yarn.api.ApplicationConstants -->
- <interface name="ApplicationConstants" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <field name="APP_SUBMIT_TIME_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The environment variable for APP_SUBMIT_TIME. Set in AppMaster environment
- only]]>
- </doc>
- </field>
- <field name="CONTAINER_TOKEN_FILE_ENV_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The cache file into which container token is written]]>
- </doc>
- </field>
- <field name="APPLICATION_WEB_PROXY_BASE_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The environmental variable for APPLICATION_WEB_PROXY_BASE. Set in
- ApplicationMaster's environment only. This states that for all non-relative
- web URLs in the app masters web UI what base should they have.]]>
- </doc>
- </field>
- <field name="LOG_DIR_EXPANSION_VAR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The temporary environmental variable for container log directory. This
- should be replaced by real container log directory on container launch.]]>
- </doc>
- </field>
- <field name="CLASS_PATH_SEPARATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This constant is used to construct class path and it will be replaced with
- real class path separator(':' for Linux and ';' for Windows) by
- NodeManager on container launch. User has to use this constant to construct
- class path if user wants cross-platform practice i.e. submit an application
- from a Windows client to a Linux/Unix server or vice versa.]]>
- </doc>
- </field>
- <field name="PARAMETER_EXPANSION_LEFT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The following two constants are used to expand parameter and it will be
- replaced with real parameter expansion marker ('%' for Windows and '$' for
- Linux) by NodeManager on container launch. For example: {{VAR}} will be
- replaced as $VAR on Linux, and %VAR% on Windows. User has to use this
- constant to construct class path if user wants cross-platform practice i.e.
- submit an application from a Windows client to a Linux/Unix server or vice
- versa.]]>
- </doc>
- </field>
- <field name="PARAMETER_EXPANSION_RIGHT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[User has to use this constant to construct class path if user wants
- cross-platform practice i.e. submit an application from a Windows client to
- a Linux/Unix server or vice versa.]]>
- </doc>
- </field>
- <field name="STDERR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="STDOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAX_APP_ATTEMPTS_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The environment variable for MAX_APP_ATTEMPTS. Set in AppMaster environment
- only]]>
- </doc>
- </field>
- <doc>
- <![CDATA[This is the API for the applications comprising of constants that YARN sets
- up for the applications and the containers.
- TODO: Investigate the semantics and security of each cross-boundary refs.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ApplicationConstants -->
- <!-- start class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
- <class name="ApplicationConstants.Environment" extends="java.lang.Enum"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.ApplicationConstants.Environment"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="key" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="$" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Expand the environment variable based on client OS environment variable
- expansion syntax (e.g. $VAR for Linux and %VAR% for Windows).
- <p>
- Note: Use $$() method for cross-platform practice i.e. submit an
- application from a Windows client to a Linux/Unix server or vice versa.
- </p>]]>
- </doc>
- </method>
- <method name="$$" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Expand the environment variable in platform-agnostic syntax. The
- parameter expansion marker "{{VAR}}" will be replaced with real parameter
- expansion marker ('%' for Windows and '$' for Linux) by NodeManager on
- container launch. For example: {{VAR}} will be replaced as $VAR on Linux,
- and %VAR% on Windows.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Environment for Applications.
- Some of the environment variables for applications are <em>final</em>
- i.e. they cannot be modified by the applications.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.ApplicationConstants.Environment -->
- <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
- <interface name="ApplicationHistoryProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of an Application from the
- <code>ResourceManager</code>.
- </p>
- <p>
- The client, via {@link GetApplicationReportRequest} provides the
- {@link ApplicationId} of the application.
- </p>
- <p>
- In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
- the application, queue etc. before accepting the request.
- </p>
- <p>
- The <code>ApplicationHistoryServer</code> responds with a
- {@link GetApplicationReportResponse} which includes the
- {@link ApplicationReport} for the application.
- </p>
- <p>
- If the user does not have <code>VIEW_APP</code> access then the following
- fields in the report will be set to stubbed values:
- <ul>
- <li>host - set to "N/A"</li>
- <li>RPC port - set to -1</li>
- <li>client token - set to "N/A"</li>
- <li>diagnostics - set to "N/A"</li>
- <li>tracking URL - set to "N/A"</li>
- <li>original tracking URL - set to "N/A"</li>
- <li>resource usage report - all values are -1</li>
- </ul>
- </p>
- @param request
- request for an application report
- @return application report
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getApplications" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of all Applications in the
- cluster from the <code>ApplicationHistoryServer</code>.
- </p>
- <p>
- The <code>ApplicationHistoryServer</code> responds with a
- {@link GetApplicationsResponse} which includes a list of
- {@link ApplicationReport} for all the applications.
- </p>
- <p>
- If the user does not have <code>VIEW_APP</code> access for an application
- then the corresponding report will be filtered as described in
- {@link #getApplicationReport(GetApplicationReportRequest)}.
- </p>
- @param request
- request for reports on all the applications
- @return report on applications matching the given application types defined
- in the request
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of an Application Attempt
- from the <code>ApplicationHistoryServer</code>.
- </p>
- <p>
- The client, via {@link GetApplicationAttemptReportRequest} provides the
- {@link ApplicationAttemptId} of the application attempt.
- </p>
- <p>
- In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
- the method before accepting the request.
- </p>
- <p>
- The <code>ApplicationHistoryServer</code> responds with a
- {@link GetApplicationAttemptReportResponse} which includes the
- {@link ApplicationAttemptReport} for the application attempt.
- </p>
- <p>
- If the user does not have <code>VIEW_APP</code> access then the following
- fields in the report will be set to stubbed values:
- <ul>
- <li>host</li>
- <li>RPC port</li>
- <li>client token</li>
- <li>diagnostics - set to "N/A"</li>
- <li>tracking URL</li>
- </ul>
- </p>
- @param request
- request for an application attempt report
- @return application attempt report
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getApplicationAttempts" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of all Application attempts
- in the cluster from the <code>ApplicationHistoryServer</code>.
- </p>
- <p>
- The <code>ApplicationHistoryServer</code> responds with a
- {@link GetApplicationAttemptsRequest} which includes the
- {@link ApplicationAttemptReport} for all the applications attempts of a
- specified application attempt.
- </p>
- <p>
- If the user does not have <code>VIEW_APP</code> access for an application
- then the corresponding report will be filtered as described in
- {@link #getApplicationAttemptReport(GetApplicationAttemptReportRequest)}.
- </p>
- @param request
- request for reports on all application attempts of an application
- @return reports on all application attempts of an application
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getContainerReport" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of an Container from the
- <code>ApplicationHistoryServer</code>.
- </p>
- <p>
- The client, via {@link GetContainerReportRequest} provides the
- {@link ContainerId} of the container.
- </p>
- <p>
- In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
- the method before accepting the request.
- </p>
- <p>
- The <code>ApplicationHistoryServer</code> responds with a
- {@link GetContainerReportResponse} which includes the
- {@link ContainerReport} for the container.
- </p>
- @param request
- request for a container report
- @return container report
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getContainers" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get a report of Containers for an
- application attempt from the <code>ApplciationHistoryServer</code>.
- </p>
- <p>
- The client, via {@link GetContainersRequest} provides the
- {@link ApplicationAttemptId} of the application attempt.
- </p>
- <p>
- In secure mode,the <code>ApplicationHistoryServer</code> verifies access to
- the method before accepting the request.
- </p>
- <p>
- The <code>ApplicationHistoryServer</code> responds with a
- {@link GetContainersResponse} which includes a list of
- {@link ContainerReport} for all the containers of a specific application
- attempt.
- </p>
- @param request
- request for a list of container reports of an application attempt.
- @return reports on all containers of an application attempt
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getDelegationToken" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by clients to get delegation token, enabling the
- containers to be able to talk to the service using those tokens.
- </p>
- <p>
- The <code>ApplicationHistoryServer</code> responds with the delegation
- token {@link Token} that can be used by the client to speak to this
- service.
- </p>
- @param request
- request to get a delegation token for the client.
- @return delegation token that can be used to talk to this service
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The protocol between clients and the <code>ApplicationHistoryServer</code> to
- get the information of completed applications etc.
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
- <!-- start interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
- <interface name="ApplicationMasterProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="registerApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface used by a new <code>ApplicationMaster</code> to register with
- the <code>ResourceManager</code>.
- </p>
- <p>
- The <code>ApplicationMaster</code> needs to provide details such as RPC
- Port, HTTP tracking url etc. as specified in
- {@link RegisterApplicationMasterRequest}.
- </p>
- <p>
- The <code>ResourceManager</code> responds with critical details such as
- maximum resource capabilities in the cluster as specified in
- {@link RegisterApplicationMasterResponse}.
- </p>
- @param request
- registration request
- @return registration respose
- @throws YarnException
- @throws IOException
- @throws InvalidApplicationMasterRequestException
- The exception is thrown when an ApplicationMaster tries to
- register more then once.
- @see RegisterApplicationMasterRequest
- @see RegisterApplicationMasterResponse]]>
- </doc>
- </method>
- <method name="finishApplicationMaster" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>The interface used by an <code>ApplicationMaster</code> to notify the
- <code>ResourceManager</code> about its completion (success or failed).</p>
- <p>The <code>ApplicationMaster</code> has to provide details such as
- final state, diagnostics (in case of failures) etc. as specified in
- {@link FinishApplicationMasterRequest}.</p>
- <p>The <code>ResourceManager</code> responds with
- {@link FinishApplicationMasterResponse}.</p>
- @param request completion request
- @return completion response
- @throws YarnException
- @throws IOException
- @see FinishApplicationMasterRequest
- @see FinishApplicationMasterResponse]]>
- </doc>
- </method>
- <method name="allocate" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The main interface between an <code>ApplicationMaster</code> and the
- <code>ResourceManager</code>.
- </p>
- <p>
- The <code>ApplicationMaster</code> uses this interface to provide a list of
- {@link ResourceRequest} and returns unused {@link Container} allocated to
- it via {@link AllocateRequest}. Optionally, the
- <code>ApplicationMaster</code> can also <em>blacklist</em> resources which
- it doesn't want to use.
- </p>
- <p>
- This also doubles up as a <em>heartbeat</em> to let the
- <code>ResourceManager</code> know that the <code>ApplicationMaster</code>
- is alive. Thus, applications should periodically make this call to be kept
- alive. The frequency depends on
- {@link YarnConfiguration#RM_AM_EXPIRY_INTERVAL_MS} which defaults to
- {@link YarnConfiguration#DEFAULT_RM_AM_EXPIRY_INTERVAL_MS}.
- </p>
- <p>
- The <code>ResourceManager</code> responds with list of allocated
- {@link Container}, status of completed containers and headroom information
- for the application.
- </p>
- <p>
- The <code>ApplicationMaster</code> can use the available headroom
- (resources) to decide how to utilized allocated resources and make informed
- decisions about future resource requests.
- </p>
- @param request
- allocation request
- @return allocation response
- @throws YarnException
- @throws IOException
- @throws InvalidApplicationMasterRequestException
- This exception is thrown when an ApplicationMaster calls allocate
- without registering first.
- @throws InvalidResourceBlacklistRequestException
- This exception is thrown when an application provides an invalid
- specification for blacklist of resources.
- @throws InvalidResourceRequestException
- This exception is thrown when a {@link ResourceRequest} is out of
- the range of the configured lower and upper limits on the
- resources.
- @see AllocateRequest
- @see AllocateResponse]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The protocol between a live instance of <code>ApplicationMaster</code>
- and the <code>ResourceManager</code>.</p>
- <p>This is used by the <code>ApplicationMaster</code> to register/unregister
- and to request and obtain resources in the cluster from the
- <code>ResourceManager</code>.</p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ApplicationMasterProtocol -->
- <!-- start interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
- <interface name="ContainerManagementProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="startContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The <code>ApplicationMaster</code> provides a list of
- {@link StartContainerRequest}s to a <code>NodeManager</code> to
- <em>start</em> {@link Container}s allocated to it using this interface.
- </p>
- <p>
- The <code>ApplicationMaster</code> has to provide details such as allocated
- resource capability, security tokens (if enabled), command to be executed
- to start the container, environment for the process, necessary
- binaries/jar/shared-objects etc. via the {@link ContainerLaunchContext} in
- the {@link StartContainerRequest}.
- </p>
- <p>
- The <code>NodeManager</code> sends a response via
- {@link StartContainersResponse} which includes a list of
- {@link Container}s of successfully launched {@link Container}s, a
- containerId-to-exception map for each failed {@link StartContainerRequest} in
- which the exception indicates errors from per container and a
- allServicesMetaData map between the names of auxiliary services and their
- corresponding meta-data. Note: None-container-specific exceptions will
- still be thrown by the API method itself.
- </p>
- <p>
- The <code>ApplicationMaster</code> can use
- {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
- statuses of the to-be-launched or launched containers.
- </p>
- @param request
- request to start a list of containers
- @return response including conatinerIds of all successfully launched
- containers, a containerId-to-exception map for failed requests and
- a allServicesMetaData map.
- @throws YarnException
- @throws IOException
- @throws NMNotYetReadyException
- This exception is thrown when NM starts from scratch but has not
- yet connected with RM.]]>
- </doc>
- </method>
- <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The <code>ApplicationMaster</code> requests a <code>NodeManager</code> to
- <em>stop</em> a list of {@link Container}s allocated to it using this
- interface.
- </p>
- <p>
- The <code>ApplicationMaster</code> sends a {@link StopContainersRequest}
- which includes the {@link ContainerId}s of the containers to be stopped.
- </p>
- <p>
- The <code>NodeManager</code> sends a response via
- {@link StopContainersResponse} which includes a list of {@link ContainerId}
- s of successfully stopped containers, a containerId-to-exception map for
- each failed request in which the exception indicates errors from per
- container. Note: None-container-specific exceptions will still be thrown by
- the API method itself. <code>ApplicationMaster</code> can use
- {@link #getContainerStatuses(GetContainerStatusesRequest)} to get updated
- statuses of the containers.
- </p>
- @param request
- request to stop a list of containers
- @return response which includes a list of containerIds of successfully
- stopped containers, a containerId-to-exception map for failed
- requests.
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getContainerStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The API used by the <code>ApplicationMaster</code> to request for current
- statuses of <code>Container</code>s from the <code>NodeManager</code>.
- </p>
- <p>
- The <code>ApplicationMaster</code> sends a
- {@link GetContainerStatusesRequest} which includes the {@link ContainerId}s
- of all containers whose statuses are needed.
- </p>
- <p>
- The <code>NodeManager</code> responds with
- {@link GetContainerStatusesResponse} which includes a list of
- {@link ContainerStatus} of the successfully queried containers and a
- containerId-to-exception map for each failed request in which the exception
- indicates errors from per container. Note: None-container-specific
- exceptions will still be thrown by the API method itself.
- </p>
- @param request
- request to get <code>ContainerStatus</code>es of containers with
- the specified <code>ContainerId</code>s
- @return response containing the list of <code>ContainerStatus</code> of the
- successfully queried containers and a containerId-to-exception map
- for failed requests.
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
- <code>NodeManager</code> to start/stop containers and to get status
- of running containers.</p>
- <p>If security is enabled the <code>NodeManager</code> verifies that the
- <code>ApplicationMaster</code> has truly been allocated the container
- by the <code>ResourceManager</code> and also verifies all interactions such
- as stopping the container or obtaining status information for the container.
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ContainerManagementProtocol -->
- </package>
- <package name="org.apache.hadoop.yarn.api.protocolrecords">
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
- <class name="AllocateRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AllocateRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="responseID" type="int"/>
- <param name="appProgress" type="float"/>
- <param name="resourceAsk" type="java.util.List"/>
- <param name="containersToBeReleased" type="java.util.List"/>
- <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="responseID" type="int"/>
- <param name="appProgress" type="float"/>
- <param name="resourceAsk" type="java.util.List"/>
- <param name="containersToBeReleased" type="java.util.List"/>
- <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
- <param name="increaseRequests" type="java.util.List"/>
- </method>
- <method name="getResponseId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>response id</em> used to track duplicate responses.
- @return <em>response id</em>]]>
- </doc>
- </method>
- <method name="setResponseId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="int"/>
- <doc>
- <![CDATA[Set the <em>response id</em> used to track duplicate responses.
- @param id <em>response id</em>]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>current progress</em> of application.
- @return <em>current progress</em> of application]]>
- </doc>
- </method>
- <method name="setProgress"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="progress" type="float"/>
- <doc>
- <![CDATA[Set the <em>current progress</em> of application
- @param progress <em>current progress</em> of application]]>
- </doc>
- </method>
- <method name="getAskList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>ResourceRequest</code> to update the
- <code>ResourceManager</code> about the application's resource requirements.
- @return the list of <code>ResourceRequest</code>
- @see ResourceRequest]]>
- </doc>
- </method>
- <method name="setAskList"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceRequests" type="java.util.List"/>
- <doc>
- <![CDATA[Set list of <code>ResourceRequest</code> to update the
- <code>ResourceManager</code> about the application's resource requirements.
- @param resourceRequests list of <code>ResourceRequest</code> to update the
- <code>ResourceManager</code> about the application's
- resource requirements
- @see ResourceRequest]]>
- </doc>
- </method>
- <method name="getReleaseList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>ContainerId</code> of containers being
- released by the <code>ApplicationMaster</code>.
- @return list of <code>ContainerId</code> of containers being
- released by the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setReleaseList"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="releaseContainers" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list of <code>ContainerId</code> of containers being
- released by the <code>ApplicationMaster</code>
- @param releaseContainers list of <code>ContainerId</code> of
- containers being released by the
- <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getResourceBlacklistRequest" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ResourceBlacklistRequest</code> being sent by the
- <code>ApplicationMaster</code>.
- @return the <code>ResourceBlacklistRequest</code> being sent by the
- <code>ApplicationMaster</code>
- @see ResourceBlacklistRequest]]>
- </doc>
- </method>
- <method name="setResourceBlacklistRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
- <doc>
- <![CDATA[Set the <code>ResourceBlacklistRequest</code> to inform the
- <code>ResourceManager</code> about the blacklist additions and removals
- per the <code>ApplicationMaster</code>.
- @param resourceBlacklistRequest the <code>ResourceBlacklistRequest</code>
- to inform the <code>ResourceManager</code> about
- the blacklist additions and removals
- per the <code>ApplicationMaster</code>
- @see ResourceBlacklistRequest]]>
- </doc>
- </method>
- <method name="getIncreaseRequests" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerResourceIncreaseRequest</code> being sent by the
- <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setIncreaseRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="increaseRequests" type="java.util.List"/>
- <doc>
- <![CDATA[Set the <code>ContainerResourceIncreaseRequest</code> to inform the
- <code>ResourceManager</code> about some container's resources need to be
- increased]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The core request sent by the <code>ApplicationMaster</code> to the
- <code>ResourceManager</code> to obtain resources in the cluster.</p>
- <p>The request includes:
- <ul>
- <li>A response id to track duplicate responses.</li>
- <li>Progress information.</li>
- <li>
- A list of {@link ResourceRequest} to inform the
- <code>ResourceManager</code> about the application's
- resource requirements.
- </li>
- <li>
- A list of unused {@link Container} which are being returned.
- </li>
- </ul>
- </p>
- @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
- <class name="AllocateResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AllocateResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="responseId" type="int"/>
- <param name="completedContainers" type="java.util.List"/>
- <param name="allocatedContainers" type="java.util.List"/>
- <param name="updatedNodes" type="java.util.List"/>
- <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
- <param name="numClusterNodes" type="int"/>
- <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
- <param name="nmTokens" type="java.util.List"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="responseId" type="int"/>
- <param name="completedContainers" type="java.util.List"/>
- <param name="allocatedContainers" type="java.util.List"/>
- <param name="updatedNodes" type="java.util.List"/>
- <param name="availResources" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="command" type="org.apache.hadoop.yarn.api.records.AMCommand"/>
- <param name="numClusterNodes" type="int"/>
- <param name="preempt" type="org.apache.hadoop.yarn.api.records.PreemptionMessage"/>
- <param name="nmTokens" type="java.util.List"/>
- <param name="increasedContainers" type="java.util.List"/>
- <param name="decreasedContainers" type="java.util.List"/>
- </method>
- <method name="getAMCommand" return="org.apache.hadoop.yarn.api.records.AMCommand"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If the <code>ResourceManager</code> needs the
- <code>ApplicationMaster</code> to take some action then it will send an
- AMCommand to the <code>ApplicationMaster</code>. See <code>AMCommand</code>
- for details on commands and actions for them.
- @return <code>AMCommand</code> if the <code>ApplicationMaster</code> should
- take action, <code>null</code> otherwise
- @see AMCommand]]>
- </doc>
- </method>
- <method name="getResponseId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>last response id</em>.
- @return <em>last response id</em>]]>
- </doc>
- </method>
- <method name="getAllocatedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <em>newly allocated</em> <code>Container</code> by the
- <code>ResourceManager</code>.
- @return list of <em>newly allocated</em> <code>Container</code>]]>
- </doc>
- </method>
- <method name="getAvailableResources" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>available headroom</em> for resources in the cluster for the
- application.
- @return limit of available headroom for resources in the cluster for the
- application]]>
- </doc>
- </method>
- <method name="getCompletedContainersStatuses" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <em>completed containers' statuses</em>.
- @return the list of <em>completed containers' statuses</em>]]>
- </doc>
- </method>
- <method name="getUpdatedNodes" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <em>updated <code>NodeReport</code>s</em>. Updates could
- be changes in health, availability etc of the nodes.
- @return The delta of updated nodes since the last response]]>
- </doc>
- </method>
- <method name="getNumClusterNodes" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of hosts available on the cluster.
- @return the available host count.]]>
- </doc>
- </method>
- <method name="getPreemptionMessage" return="org.apache.hadoop.yarn.api.records.PreemptionMessage"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>Get the description of containers owned by the AM, but requested back by
- the cluster. Note that the RM may have an inconsistent view of the
- resources owned by the AM. These messages are advisory, and the AM may
- elect to ignore them.<p>
- <p>The message is a snapshot of the resources the RM wants back from the AM.
- While demand persists, the RM will repeat its request; applications should
- not interpret each message as a request for <em>additional<em>
- resources on top of previous messages. Resources requested consistently
- over some duration may be forcibly killed by the RM.<p>
- @return A specification of the resources to reclaim from this AM.]]>
- </doc>
- </method>
- <method name="getNMTokens" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>Get the list of NMTokens required for communicating with NM. New NMTokens
- issued only if<p>
- <p>1) AM is receiving first container on underlying NodeManager.<br>
- OR<br>
- 2) NMToken master key rolled over in ResourceManager and AM is getting new
- container on the same underlying NodeManager.<p>
- <p>AM will receive one NMToken per NM irrespective of the number of containers
- issued on same NM. AM is expected to store these tokens until issued a
- new token for the same NM.<p>]]>
- </doc>
- </method>
- <method name="getIncreasedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of newly increased containers by <code>ResourceManager</code>]]>
- </doc>
- </method>
- <method name="getDecreasedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of newly decreased containers by <code>NodeManager</code>]]>
- </doc>
- </method>
- <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The AMRMToken that belong to this attempt
- @return The AMRMToken that belong to this attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> the
- <code>ApplicationMaster</code> during resource negotiation.</p>
- <p>The response, includes:
- <ul>
- <li>Response ID to track duplicate responses.</li>
- <li>
- An AMCommand sent by ResourceManager to let the <code>ApplicationMaster</code>
- take some actions (resync, shutdown etc.).
- <li>A list of newly allocated {@link Container}.</li>
- <li>A list of completed {@link Container}s' statuses.</li>
- <li>
- The available headroom for resources in the cluster for the
- application.
- </li>
- <li>A list of nodes whose status has been updated.</li>
- <li>The number of available nodes in a cluster.</li>
- <li>A description of resources requested back by the cluster</li>
- <li>AMRMToken, if AMRMToken has been rolled over</li>
- </ul>
- </p>
- @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
- <class name="ApplicationsRequestScope" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration that controls the scope of applications fetched]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
- <class name="FinishApplicationMasterRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FinishApplicationMasterRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="finalAppStatus" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
- <param name="diagnostics" type="java.lang.String"/>
- <param name="url" type="java.lang.String"/>
- </method>
- <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>final state</em> of the <code>ApplicationMaster</code>.
- @return <em>final state</em> of the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setFinalApplicationStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="finalState" type="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"/>
- <doc>
- <![CDATA[Set the <em>final state</em> of the <code>ApplicationMaster</code>
- @param finalState <em>final state</em> of the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getDiagnostics" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>diagnostic information</em> on application failure.
- @return <em>diagnostic information</em> on application failure]]>
- </doc>
- </method>
- <method name="setDiagnostics"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="diagnostics" type="java.lang.String"/>
- <doc>
- <![CDATA[Set <em>diagnostic information</em> on application failure.
- @param diagnostics <em>diagnostic information</em> on application failure]]>
- </doc>
- </method>
- <method name="getTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
- This url if contains scheme then that will be used by resource manager
- web application proxy otherwise it will default to http.
- @return <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setTrackingUrl"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>final tracking URL</em>for the <code>ApplicationMaster</code>.
- This is the web-URL to which ResourceManager or web-application proxy will
- redirect client/users once the application is finished and the
- <code>ApplicationMaster</code> is gone.
- <p>
- If the passed url has a scheme then that will be used by the
- ResourceManager and web-application proxy, otherwise the scheme will
- default to http.
- </p>
- <p>
- Empty, null, "N/A" strings are all valid besides a real URL. In case an url
- isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
- <p>
- @param url
- <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The finalization request sent by the <code>ApplicationMaster</code> to
- inform the <code>ResourceManager</code> about its completion.</p>
- <p>The final request includes details such:
- <ul>
- <li>Final state of the <code>ApplicationMaster</code></li>
- <li>
- Diagnostic information in case of failure of the
- <code>ApplicationMaster</code>
- </li>
- <li>Tracking URL</li>
- </ul>
- </p>
- @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
- <class name="FinishApplicationMasterResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FinishApplicationMasterResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getIsUnregistered" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the flag which indicates that the application has successfully
- unregistered with the RM and the application can safely stop.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a
- <code>ApplicationMaster</code> on it's completion.
- </p>
- <p>
- The response, includes:
- <ul>
- <li>A flag which indicates that the application has successfully unregistered
- with the RM and the application can safely stop.</li>
- </ul>
- </p>
- Note: The flag indicates whether the application has successfully
- unregistered and is safe to stop. The application may stop after the flag is
- true. If the application stops before the flag is true then the RM may retry
- the application .
- @see ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FinishApplicationMasterResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
- <class name="GetApplicationAttemptReportRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationAttemptReportRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- </method>
- <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
- @return <code>ApplicationAttemptId</code> of an application attempt]]>
- </doc>
- </method>
- <method name="setApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
- @param applicationAttemptId
- <code>ApplicationAttemptId</code> of an application attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request sent by a client to the <code>ResourceManager</code> to get an
- {@link ApplicationAttemptReport} for an application attempt.
- </p>
- <p>
- The request should include the {@link ApplicationAttemptId} of the
- application attempt.
- </p>
- @see ApplicationAttemptReport
- @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
- <class name="GetApplicationAttemptReportResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationAttemptReportResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ApplicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
- </method>
- <method name="getApplicationAttemptReport" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
- @return <code>ApplicationAttemptReport</code> for the application attempt]]>
- </doc>
- </method>
- <method name="setApplicationAttemptReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptReport" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"/>
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptReport</code> for the application attempt.
- @param applicationAttemptReport
- <code>ApplicationAttemptReport</code> for the application attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- an application attempt report.
- </p>
- <p>
- The response includes an {@link ApplicationAttemptReport} which has the
- details about the particular application attempt
- </p>
- @see ApplicationAttemptReport
- @see ApplicationHistoryProtocol#getApplicationAttemptReport(GetApplicationAttemptReportRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptReportResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
- <class name="GetApplicationAttemptsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationAttemptsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of an application
- @return <code>ApplicationId</code> of an application]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of an application
- @param applicationId
- <code>ApplicationId</code> of an application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request from clients to get a list of application attempt reports of an
- application from the <code>ResourceManager</code>.
- </p>
- @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
- <class name="GetApplicationAttemptsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationAttemptsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttempts" type="java.util.List"/>
- </method>
- <method name="getApplicationAttemptList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
- @return a list of <code>ApplicationReport</code> of an application]]>
- </doc>
- </method>
- <method name="setApplicationAttemptList"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttempts" type="java.util.List"/>
- <doc>
- <![CDATA[Get a list of <code>ApplicationReport</code> of an application.
- @param applicationAttempts
- a list of <code>ApplicationReport</code> of an application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- a list of {@link ApplicationAttemptReport} for application attempts.
- </p>
- <p>
- The <code>ApplicationAttemptReport</code> for each application includes the
- details of an application attempt.
- </p>
- @see ApplicationAttemptReport
- @see ApplicationHistoryProtocol#getApplicationAttempts(GetApplicationAttemptsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationAttemptsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
- <class name="GetApplicationReportRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationReportRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the application.
- @return <code>ApplicationId</code> of the application]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the application
- @param applicationId <code>ApplicationId</code> of the application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by a client to the <code>ResourceManager</code> to
- get an {@link ApplicationReport} for an application.</p>
- <p>The request should include the {@link ApplicationId} of the
- application.</p>
- @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)
- @see ApplicationReport]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
- <class name="GetApplicationReportResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationReportResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationReport" return="org.apache.hadoop.yarn.api.records.ApplicationReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationReport</code> for the application.
- @return <code>ApplicationReport</code> for the application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
- requesting an application report.</p>
- <p>The response includes an {@link ApplicationReport} which has details such
- as user, queue, name, host on which the <code>ApplicationMaster</code> is
- running, RPC port, tracking URL, diagnostics, start time etc.</p>
- @see ApplicationClientProtocol#getApplicationReport(GetApplicationReportRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
- <class name="GetApplicationsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
- <param name="users" type="java.util.Set"/>
- <param name="queues" type="java.util.Set"/>
- <param name="applicationTypes" type="java.util.Set"/>
- <param name="applicationTags" type="java.util.Set"/>
- <param name="applicationStates" type="java.util.EnumSet"/>
- <param name="startRange" type="org.apache.commons.lang.math.LongRange"/>
- <param name="finishRange" type="org.apache.commons.lang.math.LongRange"/>
- <param name="limit" type="java.lang.Long"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving application types in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)
- <p>Setting any of the parameters to null, would just disable that
- filter</p>
- @param scope {@link ApplicationsRequestScope} to filter by
- @param users list of users to filter by
- @param queues list of scheduler queues to filter by
- @param applicationTypes types of applications
- @param applicationTags application tags to filter by
- @param applicationStates application states to filter by
- @param startRange range of application start times to filter by
- @param finishRange range of application finish times to filter by
- @param limit number of applications to limit to
- @return {@link GetApplicationsRequest} to be used with
- {@link ApplicationClientProtocol#getApplications(GetApplicationsRequest)}]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="org.apache.hadoop.yarn.api.protocolrecords.ApplicationsRequestScope"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving application types in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @param scope {@link ApplicationsRequestScope} to filter by
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationTypes" type="java.util.Set"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving application types in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationStates" type="java.util.EnumSet"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving application states in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationTypes" type="java.util.Set"/>
- <param name="applicationStates" type="java.util.EnumSet"/>
- <doc>
- <![CDATA[<p>
- The request from clients to get a report of Applications matching the
- giving and application types and application types in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </method>
- <method name="getApplicationTypes" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application types to filter applications on
- @return Set of Application Types to filter on]]>
- </doc>
- </method>
- <method name="getApplicationStates" return="java.util.EnumSet"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application states to filter applications on
- @return Set of Application states to filter on]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request from clients to get a report of Applications
- in the cluster from the <code>ResourceManager</code>.</p>
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
- <class name="GetApplicationsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetApplicationsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>ApplicationReport</code> for applications.
- @return <code>ApplicationReport</code> for applications]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
- requesting an {@link ApplicationReport} for applications.</p>
- <p>The <code>ApplicationReport</code> for each application includes details
- such as user, queue, name, host on which the <code>ApplicationMaster</code>
- is running, RPC port, tracking URL, diagnostics, start time etc.</p>
- @see ApplicationReport
- @see ApplicationClientProtocol#getApplications(GetApplicationsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetApplicationsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
- <class name="GetClusterMetricsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterMetricsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>The request sent by clients to get cluster metrics from the
- <code>ResourceManager</code>.</p>
- <p>Currently, this is empty.</p>
- @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
- <class name="GetClusterMetricsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterMetricsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getClusterMetrics" return="org.apache.hadoop.yarn.api.records.YarnClusterMetrics"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>YarnClusterMetrics</code> for the cluster.
- @return <code>YarnClusterMetrics</code> for the cluster]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
- requesting cluster metrics.<p>
- @see YarnClusterMetrics
- @see ApplicationClientProtocol#getClusterMetrics(GetClusterMetricsRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
- <class name="GetClusterNodeLabelsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodeLabelsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
- <class name="GetClusterNodeLabelsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodeLabelsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="labels" type="java.util.Set"/>
- </method>
- <method name="setNodeLabels"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="labels" type="java.util.Set"/>
- </method>
- <method name="getNodeLabels" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
- <class name="GetClusterNodesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="states" type="java.util.EnumSet"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNodeStates" return="java.util.EnumSet"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The state to filter the cluster nodes with.]]>
- </doc>
- </method>
- <method name="setNodeStates"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="states" type="java.util.EnumSet"/>
- <doc>
- <![CDATA[The state to filter the cluster nodes with.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request from clients to get a report of all nodes
- in the cluster from the <code>ResourceManager</code>.</p>
- The request will ask for all nodes in the given {@link NodeState}s.
- @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
- <class name="GetClusterNodesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNodeReports" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>NodeReport</code> for all nodes in the cluster.
- @return <code>NodeReport</code> for all nodes in the cluster]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
- requesting a {@link NodeReport} for all nodes.</p>
- <p>The <code>NodeReport</code> contains per-node information such as
- available resources, number of containers, tracking url, rack name, health
- status etc.
- @see NodeReport
- @see ApplicationClientProtocol#getClusterNodes(GetClusterNodesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
- <class name="GetContainerReportRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainerReportRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code> of the Container.
- @return <code>ContainerId</code> of the Container]]>
- </doc>
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <doc>
- <![CDATA[Set the <code>ContainerId</code> of the container
- @param containerId
- <code>ContainerId</code> of the container]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request sent by a client to the <code>ResourceManager</code> to get an
- {@link ContainerReport} for a container.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
- <class name="GetContainerReportResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainerReportResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
- </method>
- <method name="getContainerReport" return="org.apache.hadoop.yarn.api.records.ContainerReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerReport</code> for the container.
- @return <code>ContainerReport</code> for the container]]>
- </doc>
- </method>
- <method name="setContainerReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerReport" type="org.apache.hadoop.yarn.api.records.ContainerReport"/>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- a container report.
- </p>
- <p>
- The response includes a {@link ContainerReport} which has details of a
- container.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerReportResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
- <class name="GetContainersRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainersRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- </method>
- <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of an application attempt.
- @return <code>ApplicationAttemptId</code> of an application attempt]]>
- </doc>
- </method>
- <method name="setApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationAttemptId</code> of an application attempt
- @param applicationAttemptId
- <code>ApplicationAttemptId</code> of an application attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request from clients to get a list of container reports, which belong to
- an application attempt from the <code>ResourceManager</code>.
- </p>
- @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
- <class name="GetContainersResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainersResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containers" type="java.util.List"/>
- </method>
- <method name="getContainerList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of <code>ContainerReport</code> for all the containers of an
- application attempt.
- @return a list of <code>ContainerReport</code> for all the containers of an
- application attempt]]>
- </doc>
- </method>
- <method name="setContainerList"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containers" type="java.util.List"/>
- <doc>
- <![CDATA[Set a list of <code>ContainerReport</code> for all the containers of an
- application attempt.
- @param containers
- a list of <code>ContainerReport</code> for all the containers of
- an application attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- a list of {@link ContainerReport} for containers.
- </p>
- <p>
- The <code>ContainerReport</code> for each container includes the container
- details.
- </p>
- @see ContainerReport
- @see ApplicationHistoryProtocol#getContainers(GetContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainersResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
- <class name="GetContainerStatusesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainerStatusesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIds" type="java.util.List"/>
- </method>
- <method name="getContainerIds" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>ContainerId</code>s of containers for which to obtain
- the <code>ContainerStatus</code>.
- @return the list of <code>ContainerId</code>s of containers for which to
- obtain the <code>ContainerStatus</code>.]]>
- </doc>
- </method>
- <method name="setContainerIds"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIds" type="java.util.List"/>
- <doc>
- <![CDATA[Set a list of <code>ContainerId</code>s of containers for which to obtain
- the <code>ContainerStatus</code>
- @param containerIds
- a list of <code>ContainerId</code>s of containers for which to
- obtain the <code>ContainerStatus</code>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request sent by the <code>ApplicationMaster</code> to the
- <code>NodeManager</code> to get {@link ContainerStatus} of requested
- containers.
- </p>
- @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
- <class name="GetContainerStatusesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetContainerStatusesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getContainerStatuses" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerStatus</code>es of the requested containers.
- @return <code>ContainerStatus</code>es of the requested containers.]]>
- </doc>
- </method>
- <method name="getFailedRequests" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the containerId-to-exception map in which the exception indicates error
- from per container for failed requests]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>NodeManager</code> to the
- <code>ApplicationMaster</code> when asked to obtain the
- <code>ContainerStatus</code> of requested containers.
- </p>
- @see ContainerManagementProtocol#getContainerStatuses(GetContainerStatusesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetContainerStatusesResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
- <class name="GetDelegationTokenRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetDelegationTokenRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="java.lang.String"/>
- </method>
- <method name="getRenewer" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setRenewer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="renewer" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[The request issued by the client to get a delegation token from
- the {@code ResourceManager}.
- for more information.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
- <class name="GetDelegationTokenResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetDelegationTokenResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRMDelegationToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Delegation tokens have a identifier which maps to
- {@link AbstractDelegationTokenIdentifier}.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Response to a {@link GetDelegationTokenRequest} request
- from the client. The response contains the token that
- can be used by the containers to talk to ClientRMService.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetDelegationTokenResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
- <class name="GetNewApplicationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNewApplicationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>The request sent by clients to get a new {@link ApplicationId} for
- submitting an application.</p>
- <p>Currently, this is empty.</p>
- @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
- <class name="GetNewApplicationResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNewApplicationResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>new</em> <code>ApplicationId</code> allocated by the
- <code>ResourceManager</code>.
- @return <em>new</em> <code>ApplicationId</code> allocated by the
- <code>ResourceManager</code>]]>
- </doc>
- </method>
- <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
- <code>ResourceManager</code> in the cluster.
- @return maximum capability of allocated resources in the cluster]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
- a request to get a new {@link ApplicationId} for submitting applications.</p>
- <p>Clients can submit an application with the returned
- {@link ApplicationId}.</p>
- @see ApplicationClientProtocol#getNewApplication(GetNewApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest -->
- <class name="GetNodesToLabelsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNodesToLabelsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse -->
- <class name="GetNodesToLabelsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNodesToLabelsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="map" type="java.util.Map"/>
- </method>
- <method name="setNodeToLabels"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="map" type="java.util.Map"/>
- </method>
- <method name="getNodeToLabels" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
- <class name="GetQueueInfoRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetQueueInfoRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <param name="includeApplications" type="boolean"/>
- <param name="includeChildQueues" type="boolean"/>
- <param name="recursive" type="boolean"/>
- </method>
- <method name="getQueueName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>queue name</em> for which to get queue information.
- @return <em>queue name</em> for which to get queue information]]>
- </doc>
- </method>
- <method name="setQueueName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>queue name</em> for which to get queue information
- @param queueName <em>queue name</em> for which to get queue information]]>
- </doc>
- </method>
- <method name="getIncludeApplications" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is information about <em>active applications<e/m> required?
- @return <code>true</code> if applications' information is to be included,
- else <code>false</code>]]>
- </doc>
- </method>
- <method name="setIncludeApplications"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includeApplications" type="boolean"/>
- <doc>
- <![CDATA[Should we get fetch information about <em>active applications</em>?
- @param includeApplications fetch information about <em>active
- applications</em>?]]>
- </doc>
- </method>
- <method name="getIncludeChildQueues" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is information about <em>child queues</em> required?
- @return <code>true</code> if information about child queues is required,
- else <code>false</code>]]>
- </doc>
- </method>
- <method name="setIncludeChildQueues"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includeChildQueues" type="boolean"/>
- <doc>
- <![CDATA[Should we fetch information about <em>child queues</em>?
- @param includeChildQueues fetch information about <em>child queues</em>?]]>
- </doc>
- </method>
- <method name="getRecursive" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Is information on the entire <em>child queue hierarchy</em> required?
- @return <code>true</code> if information about entire hierarchy is
- required, <code>false</code> otherwise]]>
- </doc>
- </method>
- <method name="setRecursive"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="recursive" type="boolean"/>
- <doc>
- <![CDATA[Should we fetch information on the entire <em>child queue hierarchy</em>?
- @param recursive fetch information on the entire <em>child queue
- hierarchy</em>?]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by clients to get <em>queue information</em>
- from the <code>ResourceManager</code>.</p>
- @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
- <class name="GetQueueInfoResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetQueueInfoResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getQueueInfo" return="org.apache.hadoop.yarn.api.records.QueueInfo"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>QueueInfo</code> for the specified queue.
- @return <code>QueueInfo</code> for the specified queue]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client
- requesting information about queues in the system.</p>
- <p>The response includes a {@link QueueInfo} which has details such as
- queue name, used/total capacities, running applications, child queues etc
- .</p>
- @see QueueInfo
- @see ApplicationClientProtocol#getQueueInfo(GetQueueInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
- <class name="GetQueueUserAclsInfoRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetQueueUserAclsInfoRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>The request sent by clients to the <code>ResourceManager</code> to
- get queue acls for the <em>current user</em>.</p>
- <p>Currently, this is empty.</p>
- @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
- <class name="GetQueueUserAclsInfoResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetQueueUserAclsInfoResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getUserAclsInfoList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>QueueUserACLInfo</code> per queue for the user.
- @return <code>QueueUserACLInfo</code> per queue for the user]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to clients
- seeking queue acls for the user.</p>
- <p>The response contains a list of {@link QueueUserACLInfo} which
- provides information about {@link QueueACL} per queue.</p>
- @see QueueACL
- @see QueueUserACLInfo
- @see ApplicationClientProtocol#getQueueUserAcls(GetQueueUserAclsInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
- <class name="KillApplicationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KillApplicationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the application to be aborted.
- @return <code>ApplicationId</code> of the application to be aborted]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
- to abort a submitted application.</p>
- <p>The request includes the {@link ApplicationId} of the application to be
- aborted.</p>
- @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
- <class name="KillApplicationResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="KillApplicationResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getIsKillCompleted" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the flag which indicates that the process of killing application is completed or not.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to the client aborting
- a submitted application.
- </p>
- <p>
- The response, includes:
- <ul>
- <li>A flag which indicates that the process of killing the application is
- completed or not.</li>
- </ul>
- Note: user is recommended to wait until this flag becomes true, otherwise if
- the <code>ResourceManager</code> crashes before the process of killing the
- application is completed, the <code>ResourceManager</code> may retry this
- application on recovery.
- </p>
- @see ApplicationClientProtocol#forceKillApplication(KillApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
- <class name="MoveApplicationAcrossQueuesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MoveApplicationAcrossQueuesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="queue" type="java.lang.String"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the application to be moved.
- @return <code>ApplicationId</code> of the application to be moved]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the application to be moved.
- @param appId <code>ApplicationId</code> of the application to be moved]]>
- </doc>
- </method>
- <method name="getTargetQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the queue to place the application in.
- @return the name of the queue to place the application in]]>
- </doc>
- </method>
- <method name="setTargetQueue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the queue to place the application in.
- @param queue the name of the queue to place the application in]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
- to move a submitted application to a different queue.</p>
- <p>The request includes the {@link ApplicationId} of the application to be
- moved and the queue to place it in.</p>
- @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
- <class name="MoveApplicationAcrossQueuesResponse" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="MoveApplicationAcrossQueuesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to the client moving
- a submitted application to a different queue.
- </p>
- <p>
- A response without exception means that the move has completed successfully.
- </p>
- @see ApplicationClientProtocol#moveApplicationAcrossQueues(MoveApplicationAcrossQueuesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
- <class name="RegisterApplicationMasterRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RegisterApplicationMasterRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="trackingUrl" type="java.lang.String"/>
- <doc>
- <![CDATA[Create a new instance of <code>RegisterApplicationMasterRequest</code>.
- If <em>port, trackingUrl</em> is not used, use the following default value:
- <ul>
- <li>port: -1</li>
- <li>trackingUrl: null</li>
- </ul>
- The port is allowed to be any integer larger than or equal to -1.
- @return the new instance of <code>RegisterApplicationMasterRequest</code>]]>
- </doc>
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code> is
- running.
- @return <em>host</em> on which the <code>ApplicationMaster</code> is running]]>
- </doc>
- </method>
- <method name="setHost"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>host</em> on which the <code>ApplicationMaster</code> is
- running.
- @param host <em>host</em> on which the <code>ApplicationMaster</code>
- is running]]>
- </doc>
- </method>
- <method name="getRpcPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>RPC port</em> on which the <code>ApplicationMaster</code>
- is responding.
- @return the <em>RPC port<em> on which the <code>ApplicationMaster</code> is
- responding]]>
- </doc>
- </method>
- <method name="setRpcPort"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="port" type="int"/>
- <doc>
- <![CDATA[Set the <em>RPC port<em> on which the <code>ApplicationMaster</code> is
- responding.
- @param port <em>RPC port<em> on which the <code>ApplicationMaster</code> is
- responding]]>
- </doc>
- </method>
- <method name="getTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>tracking URL</em> for the <code>ApplicationMaster</code>.
- This url if contains scheme then that will be used by resource manager
- web application proxy otherwise it will default to http.
- @return <em>tracking URL</em> for the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="setTrackingUrl"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="trackingUrl" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>tracking URL</em>for the <code>ApplicationMaster</code> while
- it is running. This is the web-URL to which ResourceManager or
- web-application proxy will redirect client/users while the application and
- the <code>ApplicationMaster</code> are still running.
- <p>
- If the passed url has a scheme then that will be used by the
- ResourceManager and web-application proxy, otherwise the scheme will
- default to http.
- </p>
- <p>
- Empty, null, "N/A" strings are all valid besides a real URL. In case an url
- isn't explicitly passed, it defaults to "N/A" on the ResourceManager.
- <p>
- @param trackingUrl
- <em>tracking URL</em>for the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to
- <code>ResourceManager</code> on registration.</p>
- <p>The registration includes details such as:
- <ul>
- <li>Hostname on which the AM is running.</li>
- <li>RPC Port</li>
- <li>Tracking URL</li>
- </ul>
- </p>
- @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
- <class name="RegisterApplicationMasterResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RegisterApplicationMasterResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getMaximumResourceCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the maximum capability for any {@link Resource} allocated by the
- <code>ResourceManager</code> in the cluster.
- @return maximum capability of allocated resources in the cluster]]>
- </doc>
- </method>
- <method name="getApplicationACLs" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationACL</code>s for the application.
- @return all the <code>ApplicationACL</code>s]]>
- </doc>
- </method>
- <method name="getClientToAMTokenMasterKey" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>Get ClientToAMToken master key.</p>
- <p>The ClientToAMToken master key is sent to <code>ApplicationMaster</code>
- by <code>ResourceManager</code> via {@link RegisterApplicationMasterResponse}
- , used to verify corresponding ClientToAMToken.</p>]]>
- </doc>
- </method>
- <method name="setClientToAMTokenMasterKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.nio.ByteBuffer"/>
- <doc>
- <![CDATA[Set ClientToAMToken master key.]]>
- </doc>
- </method>
- <method name="getQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>Get the queue that the application was placed in.<p>]]>
- </doc>
- </method>
- <method name="setQueue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <doc>
- <![CDATA[<p>Set the queue that the application was placed in.<p>]]>
- </doc>
- </method>
- <method name="getContainersFromPreviousAttempts" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Get the list of running containers as viewed by
- <code>ResourceManager</code> from previous application attempts.
- </p>
- @return the list of running containers as viewed by
- <code>ResourceManager</code> from previous application attempts
- @see RegisterApplicationMasterResponse#getNMTokensFromPreviousAttempts()]]>
- </doc>
- </method>
- <method name="getNMTokensFromPreviousAttempts" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of NMTokens for communicating with the NMs where the
- containers of previous application attempts are running.
- @return the list of NMTokens for communicating with the NMs where the
- containers of previous application attempts are running.
- @see RegisterApplicationMasterResponse#getContainersFromPreviousAttempts()]]>
- </doc>
- </method>
- <method name="getSchedulerResourceTypes" return="java.util.EnumSet"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a set of the resource types considered by the scheduler.
- @return a Map of RM settings]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a new
- <code>ApplicationMaster</code> on registration.</p>
- <p>The response contains critical details such as:
- <ul>
- <li>Maximum capability for allocated resources in the cluster.</li>
- <li><code>ApplicationACL</code>s for the application.</li>
- <li>ClientToAMToken master key.</li>
- </ul>
- </p>
- @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
- <class name="ReservationDeleteRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationDeleteRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- </method>
- <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @return the {@link ReservationId} representing the unique id of the
- corresponding reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <method name="setReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- <doc>
- <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @param reservationId the {@link ReservationId} representing the the unique
- id of the corresponding reserved resource allocation in the
- scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationDeleteRequest} captures the set of requirements the user
- has to delete an existing reservation.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
- <class name="ReservationDeleteResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationDeleteResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[{@link ReservationDeleteResponse} contains the answer of the admission
- control system in the {@code ResourceManager} to a reservation delete
- operation. Currently response is empty if the operation was successful, if
- not an exception reporting reason for a failure.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationDeleteResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
- <class name="ReservationSubmissionRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationSubmissionRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
- <param name="queueName" type="java.lang.String"/>
- </method>
- <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationDefinition} representing the user constraints for
- this reservation
- @return the reservation definition representing user constraints]]>
- </doc>
- </method>
- <method name="setReservationDefinition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
- <doc>
- <![CDATA[Set the {@link ReservationDefinition} representing the user constraints for
- this reservation
- @param reservationDefinition the reservation request representing the
- reservation]]>
- </doc>
- </method>
- <method name="getQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name of the {@code Plan} that corresponds to the name of the
- {@link QueueInfo} in the scheduler to which the reservation will be
- submitted to.
- @return the name of the {@code Plan} that corresponds to the name of the
- {@link QueueInfo} in the scheduler to which the reservation will be
- submitted to]]>
- </doc>
- </method>
- <method name="setQueue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the name of the {@code Plan} that corresponds to the name of the
- {@link QueueInfo} in the scheduler to which the reservation will be
- submitted to
- @param queueName the name of the parent {@code Plan} that corresponds to
- the name of the {@link QueueInfo} in the scheduler to which the
- reservation will be submitted to]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationSubmissionRequest} captures the set of requirements the
- user has to create a reservation.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
- <class name="ReservationSubmissionResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationSubmissionResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @return the {@link ReservationId} representing the unique id of the
- corresponding reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationSubmissionResponse} contains the answer of the admission
- control system in the {@code ResourceManager} to a reservation create
- operation. Response contains a {@link ReservationId} if the operation was
- successful, if not an exception reporting reason for a failure.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
- <class name="ReservationUpdateRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationUpdateRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
- <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- </method>
- <method name="getReservationDefinition" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationDefinition} representing the updated user
- constraints for this reservation
- @return the reservation definition representing user constraints]]>
- </doc>
- </method>
- <method name="setReservationDefinition"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
- <doc>
- <![CDATA[Set the {@link ReservationDefinition} representing the updated user
- constraints for this reservation
- @param reservationDefinition the reservation request representing the
- reservation]]>
- </doc>
- </method>
- <method name="getReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationId}, that corresponds to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @return the {@link ReservationId} representing the unique id of the
- corresponding reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <method name="setReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- <doc>
- <![CDATA[Set the {@link ReservationId}, that correspond to a valid resource
- allocation in the scheduler (between start and end time of this
- reservation)
- @param reservationId the {@link ReservationId} representing the the unique
- id of the corresponding reserved resource allocation in the
- scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationUpdateRequest} captures the set of requirements the user
- has to update an existing reservation.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
- <class name="ReservationUpdateResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationUpdateResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[{@link ReservationUpdateResponse} contains the answer of the admission
- control system in the {@code ResourceManager} to a reservation update
- operation. Currently response is empty if the operation was successful, if
- not an exception reporting reason for a failure.
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationUpdateResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
- <class name="StartContainerRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StartContainerRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <method name="getContainerLaunchContext" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerLaunchContext</code> for the container to be started
- by the <code>NodeManager</code>.
- @return <code>ContainerLaunchContext</code> for the container to be started
- by the <code>NodeManager</code>]]>
- </doc>
- </method>
- <method name="setContainerLaunchContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <doc>
- <![CDATA[Set the <code>ContainerLaunchContext</code> for the container to be started
- by the <code>NodeManager</code>
- @param context <code>ContainerLaunchContext</code> for the container to be
- started by the <code>NodeManager</code>]]>
- </doc>
- </method>
- <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>Get the container token to be used for authorization during starting
- container.</p>
- <p>Note: {@link NMToken} will be used for authenticating communication with </code>
- NodeManager</code>.</p>
- @return the container token to be used for authorization during starting
- container.
- @see NMToken
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </method>
- <method name="setContainerToken"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="container" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
- <code>NodeManager</code> to <em>start</em> a container.</p>
- <p>The <code>ApplicationMaster</code> has to provide details such as
- allocated resource capability, security tokens (if enabled), command
- to be executed to start the container, environment for the process,
- necessary binaries/jar/shared-objects etc. via the
- {@link ContainerLaunchContext}.</p>
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
- <class name="StartContainersRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StartContainersRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="requests" type="java.util.List"/>
- </method>
- <method name="getStartContainerRequests" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of {@link StartContainerRequest} to start containers.
- @return a list of {@link StartContainerRequest} to start containers.]]>
- </doc>
- </method>
- <method name="setStartContainerRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="java.util.List"/>
- <doc>
- <![CDATA[Set a list of {@link StartContainerRequest} to start containers.
- @param request a list of {@link StartContainerRequest} to start containers]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request which contains a list of {@link StartContainerRequest} sent by
- the <code>ApplicationMaster</code> to the <code>NodeManager</code> to
- <em>start</em> containers.
- </p>
- <p>
- In each {@link StartContainerRequest}, the <code>ApplicationMaster</code> has
- to provide details such as allocated resource capability, security tokens (if
- enabled), command to be executed to start the container, environment for the
- process, necessary binaries/jar/shared-objects etc. via the
- {@link ContainerLaunchContext}.
- </p>
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
- <class name="StartContainersResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StartContainersResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSuccessfullyStartedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>ContainerId</code> s of the containers that are
- started successfully.
- @return the list of <code>ContainerId</code> s of the containers that are
- started successfully.
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </method>
- <method name="getFailedRequests" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the containerId-to-exception map in which the exception indicates error
- from per container for failed requests]]>
- </doc>
- </method>
- <method name="getAllServicesMetaData" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Get the meta-data from all auxiliary services running on the
- <code>NodeManager</code>.
- </p>
- <p>
- The meta-data is returned as a Map between the auxiliary service names and
- their corresponding per service meta-data as an opaque blob
- <code>ByteBuffer</code>
- </p>
- <p>
- To be able to interpret the per-service meta-data, you should consult the
- documentation for the Auxiliary-service configured on the NodeManager
- </p>
- @return a Map between the names of auxiliary services and their
- corresponding meta-data]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>NodeManager</code> to the
- <code>ApplicationMaster</code> when asked to <em>start</em> an allocated
- container.
- </p>
- @see ContainerManagementProtocol#startContainers(StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StartContainersResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
- <class name="StopContainersRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StopContainersRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIds" type="java.util.List"/>
- </method>
- <method name="getContainerIds" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code>s of the containers to be stopped.
- @return <code>ContainerId</code>s of containers to be stopped]]>
- </doc>
- </method>
- <method name="setContainerIds"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIds" type="java.util.List"/>
- <doc>
- <![CDATA[Set the <code>ContainerId</code>s of the containers to be stopped.
- @param containerIds <code>ContainerId</code>s of the containers to be stopped]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the <code>ApplicationMaster</code> to the
- <code>NodeManager</code> to <em>stop</em> containers.</p>
- @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
- <class name="StopContainersResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StopContainersResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSuccessfullyStoppedContainers" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of containerIds of successfully stopped containers.
- @return the list of containerIds of successfully stopped containers.]]>
- </doc>
- </method>
- <method name="getFailedRequests" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the containerId-to-exception map in which the exception indicates error
- from per container for failed requests]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>NodeManager</code> to the
- <code>ApplicationMaster</code> when asked to <em>stop</em> allocated
- containers.
- </p>
- @see ContainerManagementProtocol#stopContainers(StopContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
- <class name="SubmitApplicationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SubmitApplicationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
- </method>
- <method name="getApplicationSubmissionContext" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationSubmissionContext</code> for the application.
- @return <code>ApplicationSubmissionContext</code> for the application]]>
- </doc>
- </method>
- <method name="setApplicationSubmissionContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="context" type="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"/>
- <doc>
- <![CDATA[Set the <code>ApplicationSubmissionContext</code> for the application.
- @param context <code>ApplicationSubmissionContext</code> for the
- application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by a client to <em>submit an application</em> to the
- <code>ResourceManager</code>.</p>
- <p>The request, via {@link ApplicationSubmissionContext}, contains
- details such as queue, {@link Resource} required to run the
- <code>ApplicationMaster</code>, the equivalent of
- {@link ContainerLaunchContext} for launching the
- <code>ApplicationMaster</code> etc.
- @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
- <class name="SubmitApplicationResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SubmitApplicationResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
- application submission.</p>
- <p>Currently, this is empty.</p>
- @see ApplicationClientProtocol#submitApplication(SubmitApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationResponse -->
- </package>
- <package name="org.apache.hadoop.yarn.api.records">
- <!-- start class org.apache.hadoop.yarn.api.records.AMCommand -->
- <class name="AMCommand" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.AMCommand[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.AMCommand"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Command sent by the Resource Manager to the Application Master in the
- AllocateResponse
- @see AllocateResponse]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.AMCommand -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
- <class name="ApplicationAccessType" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ApplicationAccessType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Application access types.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAccessType -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
- <class name="ApplicationAttemptId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ApplicationAttemptId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the <code>ApplicationAttempId</code>.
- @return <code>ApplicationId</code> of the <code>ApplicationAttempId</code>]]>
- </doc>
- </method>
- <method name="getAttemptId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>attempt id</code> of the <code>Application</code>.
- @return <code>attempt id</code> of the <code>Application</code>]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <field name="appAttemptIdStrPrefix" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p><code>ApplicationAttemptId</code> denotes the particular <em>attempt</em>
- of an <code>ApplicationMaster</code> for a given {@link ApplicationId}.</p>
- <p>Multiple attempts might be needed to run an application to completion due
- to temporal failures of the <code>ApplicationMaster</code> such as hardware
- failures, connectivity issues etc. on the node on which it was scheduled.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptId -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
- <class name="ApplicationAttemptReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationAttemptReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getYarnApplicationAttemptState" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>YarnApplicationAttemptState</em> of the application attempt.
- @return <em>YarnApplicationAttemptState</em> of the application attempt]]>
- </doc>
- </method>
- <method name="getRpcPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>RPC port</em> of this attempt <code>ApplicationMaster</code>.
- @return <em>RPC port</em> of this attempt <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>host</em> on which this attempt of
- <code>ApplicationMaster</code> is running.
- @return <em>host</em> on which this attempt of
- <code>ApplicationMaster</code> is running]]>
- </doc>
- </method>
- <method name="getDiagnostics" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>diagnositic information</em> of the application attempt in case
- of errors.
- @return <em>diagnositic information</em> of the application attempt in case
- of errors]]>
- </doc>
- </method>
- <method name="getTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>tracking url</em> for the application attempt.
- @return <em>tracking url</em> for the application attempt]]>
- </doc>
- </method>
- <method name="getOriginalTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>original tracking url</em> for the application attempt.
- @return <em>original tracking url</em> for the application attempt]]>
- </doc>
- </method>
- <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of this attempt of the
- application
- @return <code>ApplicationAttemptId</code> of the attempt]]>
- </doc>
- </method>
- <method name="getAMContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code> of AMContainer for this attempt
- @return <code>ContainerId</code> of the attempt]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- <code>ApplicationAttemptReport</code> is a report of an application attempt.
- </p>
- <p>
- It includes details such as:
- <ul>
- <li>{@link ApplicationAttemptId} of the application.</li>
- <li>Host on which the <code>ApplicationMaster</code> of this attempt is
- running.</li>
- <li>RPC port of the <code>ApplicationMaster</code> of this attempt.</li>
- <li>Tracking URL.</li>
- <li>Diagnostic information in case of errors.</li>
- <li>{@link YarnApplicationAttemptState} of the application attempt.</li>
- <li>{@link ContainerId} of the master Container.</li>
- </ul>
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationAttemptReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationId -->
- <class name="ApplicationId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ApplicationId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the short integer identifier of the <code>ApplicationId</code>
- which is unique for all applications started by a particular instance
- of the <code>ResourceManager</code>.
- @return short integer identifier of the <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="getClusterTimestamp" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>start time</em> of the <code>ResourceManager</code> which is
- used to generate globally unique <code>ApplicationId</code>.
- @return <em>start time</em> of the <code>ResourceManager</code>]]>
- </doc>
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <field name="appIdStrPrefix" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p><code>ApplicationId</code> represents the <em>globally unique</em>
- identifier for an application.</p>
- <p>The globally unique nature of the identifier is achieved by using the
- <em>cluster timestamp</em> i.e. start-time of the
- <code>ResourceManager</code> along with a monotonically increasing counter
- for the application.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationId -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationReport -->
- <class name="ApplicationReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the application.
- @return <code>ApplicationId</code> of the application]]>
- </doc>
- </method>
- <method name="getCurrentApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of the current
- attempt of the application
- @return <code>ApplicationAttemptId</code> of the attempt]]>
- </doc>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>user</em> who submitted the application.
- @return <em>user</em> who submitted the application]]>
- </doc>
- </method>
- <method name="getQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>queue</em> to which the application was submitted.
- @return <em>queue</em> to which the application was submitted]]>
- </doc>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user-defined <em>name</em> of the application.
- @return <em>name</em> of the application]]>
- </doc>
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>host</em> on which the <code>ApplicationMaster</code>
- is running.
- @return <em>host</em> on which the <code>ApplicationMaster</code>
- is running]]>
- </doc>
- </method>
- <method name="getRpcPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>RPC port</em> of the <code>ApplicationMaster</code>.
- @return <em>RPC port</em> of the <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getClientToAMToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>client token</em> for communicating with the
- <code>ApplicationMaster</code>.
- <p>
- <em>ClientToAMToken</em> is the security token used by the AMs to verify
- authenticity of any <code>client</code>.
- </p>
- <p>
- The <code>ResourceManager</code>, provides a secure token (via
- {@link ApplicationReport#getClientToAMToken()}) which is verified by the
- ApplicationMaster when the client directly talks to an AM.
- </p>
- @return <em>client token</em> for communicating with the
- <code>ApplicationMaster</code>]]>
- </doc>
- </method>
- <method name="getYarnApplicationState" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>YarnApplicationState</code> of the application.
- @return <code>YarnApplicationState</code> of the application]]>
- </doc>
- </method>
- <method name="getDiagnostics" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>diagnositic information</em> of the application in case of
- errors.
- @return <em>diagnositic information</em> of the application in case
- of errors]]>
- </doc>
- </method>
- <method name="getTrackingUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>tracking url</em> for the application.
- @return <em>tracking url</em> for the application]]>
- </doc>
- </method>
- <method name="getStartTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>start time</em> of the application.
- @return <em>start time</em> of the application]]>
- </doc>
- </method>
- <method name="getFinishTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>finish time</em> of the application.
- @return <em>finish time</em> of the application]]>
- </doc>
- </method>
- <method name="getFinalApplicationStatus" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>final finish status</em> of the application.
- @return <em>final finish status</em> of the application]]>
- </doc>
- </method>
- <method name="getApplicationResourceUsageReport" return="org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieve the structure containing the job resources for this application
- @return the job resources structure for this application]]>
- </doc>
- </method>
- <method name="getProgress" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application's progress ( range 0.0 to 1.0 )
- @return application's progress]]>
- </doc>
- </method>
- <method name="getApplicationType" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application's Type
- @return application's Type]]>
- </doc>
- </method>
- <method name="getApplicationTags" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get all tags corresponding to the application
- @return Application's tags]]>
- </doc>
- </method>
- <method name="getAMRMToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the AMRM token of the application.
- <p/>
- The AMRM token is required for AM to RM scheduling operations. For
- managed Application Masters Yarn takes care of injecting it. For unmanaged
- Applications Masters, the token must be obtained via this method and set
- in the {@link org.apache.hadoop.security.UserGroupInformation} of the
- current user.
- <p/>
- The AMRM token will be returned only if all the following conditions are
- met:
- <li>
- <ul>the requester is the owner of the ApplicationMaster</ul>
- <ul>the application master is an unmanaged ApplicationMaster</ul>
- <ul>the application master is in ACCEPTED state</ul>
- </li>
- Else this method returns NULL.
- @return the AM to RM token if available.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>ApplicationReport</code> is a report of an application.</p>
- <p>It includes details such as:
- <ul>
- <li>{@link ApplicationId} of the application.</li>
- <li>Applications user.</li>
- <li>Application queue.</li>
- <li>Application name.</li>
- <li>Host on which the <code>ApplicationMaster</code> is running.</li>
- <li>RPC port of the <code>ApplicationMaster</code>.</li>
- <li>Tracking URL.</li>
- <li>{@link YarnApplicationState} of the application.</li>
- <li>Diagnostic information in case of errors.</li>
- <li>Start time of the application.</li>
- <li>Client {@link Token} of the application (if security is enabled).</li>
- </ul>
- </p>
- @see ApplicationClientProtocol#getApplicationReport(org.apache.hadoop.yarn.api.protocolrecords.GetApplicationReportRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
- <class name="ApplicationResourceUsageReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationResourceUsageReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNumUsedContainers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of used containers. -1 for invalid/inaccessible reports.
- @return the number of used containers]]>
- </doc>
- </method>
- <method name="getUsedResources" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the used <code>Resource</code>. -1 for invalid/inaccessible reports.
- @return the used <code>Resource</code>]]>
- </doc>
- </method>
- <method name="getReservedResources" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reserved <code>Resource</code>. -1 for invalid/inaccessible reports.
- @return the reserved <code>Resource</code>]]>
- </doc>
- </method>
- <method name="getNeededResources" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the needed <code>Resource</code>. -1 for invalid/inaccessible reports.
- @return the needed <code>Resource</code>]]>
- </doc>
- </method>
- <method name="getMemorySeconds" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the aggregated amount of memory (in megabytes) the application has
- allocated times the number of seconds the application has been running.
- @return the aggregated amount of memory seconds]]>
- </doc>
- </method>
- <method name="getVcoreSeconds" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the aggregated number of vcores that the application has allocated
- times the number of seconds the application has been running.
- @return the aggregated number of vcore seconds]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Contains various scheduling metrics to be reported by UI and CLI.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationResourceUsageReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
- <class name="ApplicationSubmissionContext" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationSubmissionContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- <param name="appLabelExpression" type="java.lang.String"/>
- <param name="amContainerLabelExpression" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- <param name="appLabelExpression" type="java.lang.String"/>
- <param name="resourceRequest" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- <param name="attemptFailuresValidityInterval" type="long"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <param name="applicationName" type="java.lang.String"/>
- <param name="queue" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="isUnmanagedAM" type="boolean"/>
- <param name="cancelTokensWhenComplete" type="boolean"/>
- <param name="maxAppAttempts" type="int"/>
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="applicationType" type="java.lang.String"/>
- <param name="keepContainers" type="boolean"/>
- <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationId</code> of the submitted application.
- @return <code>ApplicationId</code> of the submitted application]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationId" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the submitted application.
- @param applicationId <code>ApplicationId</code> of the submitted
- application]]>
- </doc>
- </method>
- <method name="getApplicationName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application <em>name</em>.
- @return application name]]>
- </doc>
- </method>
- <method name="setApplicationName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the application <em>name</em>.
- @param applicationName application name]]>
- </doc>
- </method>
- <method name="getQueue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>queue</em> to which the application is being submitted.
- @return <em>queue</em> to which the application is being submitted]]>
- </doc>
- </method>
- <method name="setQueue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>queue</em> to which the application is being submitted
- @param queue <em>queue</em> to which the application is being submitted]]>
- </doc>
- </method>
- <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Priority</code> of the application.
- @return <code>Priority</code> of the application]]>
- </doc>
- </method>
- <method name="getAMContainerSpec" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerLaunchContext</code> to describe the
- <code>Container</code> with which the <code>ApplicationMaster</code> is
- launched.
- @return <code>ContainerLaunchContext</code> for the
- <code>ApplicationMaster</code> container]]>
- </doc>
- </method>
- <method name="setAMContainerSpec"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="amContainer" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <doc>
- <![CDATA[Set the <code>ContainerLaunchContext</code> to describe the
- <code>Container</code> with which the <code>ApplicationMaster</code> is
- launched.
- @param amContainer <code>ContainerLaunchContext</code> for the
- <code>ApplicationMaster</code> container]]>
- </doc>
- </method>
- <method name="getUnmanagedAM" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get if the RM should manage the execution of the AM.
- If true, then the RM
- will not allocate a container for the AM and start it. It will expect the
- AM to be launched and connect to the RM within the AM liveliness period and
- fail the app otherwise. The client should launch the AM only after the RM
- has ACCEPTED the application and changed the <code>YarnApplicationState</code>.
- Such apps will not be retried by the RM on app attempt failure.
- The default value is false.
- @return true if the AM is not managed by the RM]]>
- </doc>
- </method>
- <method name="setUnmanagedAM"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="value" type="boolean"/>
- <doc>
- <![CDATA[@param value true if RM should not manage the AM]]>
- </doc>
- </method>
- <method name="getMaxAppAttempts" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return the number of max attempts of the application to be submitted]]>
- </doc>
- </method>
- <method name="setMaxAppAttempts"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="maxAppAttempts" type="int"/>
- <doc>
- <![CDATA[Set the number of max attempts of the application to be submitted. WARNING:
- it should be no larger than the global number of max attempts in the Yarn
- configuration.
- @param maxAppAttempts the number of max attempts of the application
- to be submitted.]]>
- </doc>
- </method>
- <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the resource required by the <code>ApplicationMaster</code> for this
- application. Please note this will be DEPRECATED, use <em>getResource</em>
- in <em>getAMContainerResourceRequest</em> instead.
- @return the resource required by the <code>ApplicationMaster</code> for
- this application.]]>
- </doc>
- </method>
- <method name="setResource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <doc>
- <![CDATA[Set the resource required by the <code>ApplicationMaster</code> for this
- application.
- @param resource the resource required by the <code>ApplicationMaster</code>
- for this application.]]>
- </doc>
- </method>
- <method name="getApplicationType" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application type
- @return the application type]]>
- </doc>
- </method>
- <method name="setApplicationType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the application type
- @param applicationType the application type]]>
- </doc>
- </method>
- <method name="getKeepContainersAcrossApplicationAttempts" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the flag which indicates whether to keep containers across application
- attempts or not.
- @return the flag which indicates whether to keep containers across
- application attempts or not.]]>
- </doc>
- </method>
- <method name="setKeepContainersAcrossApplicationAttempts"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="keepContainers" type="boolean"/>
- <doc>
- <![CDATA[Set the flag which indicates whether to keep containers across application
- attempts.
- <p>
- If the flag is true, running containers will not be killed when application
- attempt fails and these containers will be retrieved by the new application
- attempt on registration via
- {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}.
- </p>
- @param keepContainers
- the flag which indicates whether to keep containers across
- application attempts.]]>
- </doc>
- </method>
- <method name="getApplicationTags" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get tags for the application
- @return the application tags]]>
- </doc>
- </method>
- <method name="setApplicationTags"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tags" type="java.util.Set"/>
- <doc>
- <![CDATA[Set tags for the application. A maximum of
- {@link YarnConfiguration#APPLICATION_MAX_TAGS} are allowed
- per application. Each tag can be at most
- {@link YarnConfiguration#APPLICATION_MAX_TAG_LENGTH}
- characters, and can contain only ASCII characters.
- @param tags tags to set]]>
- </doc>
- </method>
- <method name="getNodeLabelExpression" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get node-label-expression for this app. If this is set, all containers of
- this application without setting node-label-expression in ResurceRequest
- will get allocated resources on only those nodes that satisfy this
- node-label-expression.
- If different node-label-expression of this app and ResourceRequest are set
- at the same time, the one set in ResourceRequest will be used when
- allocating container
- @return node-label-expression for this app]]>
- </doc>
- </method>
- <method name="setNodeLabelExpression"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeLabelExpression" type="java.lang.String"/>
- <doc>
- <![CDATA[Set node-label-expression for this app
- @param nodeLabelExpression node-label-expression of this app]]>
- </doc>
- </method>
- <method name="getAMContainerResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get ResourceRequest of AM container, if this is not null, scheduler will
- use this to acquire resource for AM container.
- If this is null, scheduler will assemble a ResourceRequest by using
- <em>getResource</em> and <em>getPriority</em> of
- <em>ApplicationSubmissionContext</em>.
- Number of containers and Priority will be ignore.
- @return ResourceRequest of AM container]]>
- </doc>
- </method>
- <method name="setAMContainerResourceRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- <doc>
- <![CDATA[Set ResourceRequest of AM container
- @param request of AM container]]>
- </doc>
- </method>
- <method name="getAttemptFailuresValidityInterval" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the attemptFailuresValidityInterval in milliseconds for the application
- @return the attemptFailuresValidityInterval]]>
- </doc>
- </method>
- <method name="setAttemptFailuresValidityInterval"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attemptFailuresValidityInterval" type="long"/>
- <doc>
- <![CDATA[Set the attemptFailuresValidityInterval in milliseconds for the application
- @param attemptFailuresValidityInterval]]>
- </doc>
- </method>
- <method name="getLogAggregationContext" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>LogAggregationContext</code> of the application
- @return <code>LogAggregationContext</code> of the application]]>
- </doc>
- </method>
- <method name="setLogAggregationContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logAggregationContext" type="org.apache.hadoop.yarn.api.records.LogAggregationContext"/>
- <doc>
- <![CDATA[Set <code>LogAggregationContext</code> for the application
- @param logAggregationContext
- for the application]]>
- </doc>
- </method>
- <method name="getReservationID" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reservation id, that corresponds to a valid resource allocation in
- the scheduler (between start and end time of the corresponding reservation)
- @return the reservation id representing the unique id of the corresponding
- reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <method name="setReservationID"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationID" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- <doc>
- <![CDATA[Set the reservation id, that correspond to a valid resource allocation in
- the scheduler (between start and end time of the corresponding reservation)
- @param reservationID representing the unique id of the
- corresponding reserved resource allocation in the scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>ApplicationSubmissionContext</code> represents all of the
- information needed by the <code>ResourceManager</code> to launch
- the <code>ApplicationMaster</code> for an application.</p>
- <p>It includes details such as:
- <ul>
- <li>{@link ApplicationId} of the application.</li>
- <li>Application user.</li>
- <li>Application name.</li>
- <li>{@link Priority} of the application.</li>
- <li>
- {@link ContainerLaunchContext} of the container in which the
- <code>ApplicationMaster</code> is executed.
- </li>
- <li>maxAppAttempts. The maximum number of application attempts.
- It should be no larger than the global number of max attempts in the
- Yarn configuration.</li>
- <li>attemptFailuresValidityInterval. The default value is -1.
- when attemptFailuresValidityInterval in milliseconds is set to > 0,
- the failure number will no take failures which happen out of the
- validityInterval into failure count. If failure count reaches to
- maxAppAttempts, the application will be failed.
- </li>
- <li>Optional, application-specific {@link LogAggregationContext}</li>
- </ul>
- </p>
- @see ContainerLaunchContext
- @see ApplicationClientProtocol#submitApplication(org.apache.hadoop.yarn.api.protocolrecords.SubmitApplicationRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext -->
- <!-- start class org.apache.hadoop.yarn.api.records.Container -->
- <class name="Container" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Container"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the globally unique identifier for the container.
- @return globally unique identifier for the container]]>
- </doc>
- </method>
- <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the identifier of the node on which the container is allocated.
- @return identifier of the node on which the container is allocated]]>
- </doc>
- </method>
- <method name="getNodeHttpAddress" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the http uri of the node on which the container is allocated.
- @return http uri of the node on which the container is allocated]]>
- </doc>
- </method>
- <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Resource</code> allocated to the container.
- @return <code>Resource</code> allocated to the container]]>
- </doc>
- </method>
- <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Priority</code> at which the <code>Container</code> was
- allocated.
- @return <code>Priority</code> at which the <code>Container</code> was
- allocated]]>
- </doc>
- </method>
- <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerToken</code> for the container.
- <p><code>ContainerToken</code> is the security token used by the framework
- to verify authenticity of any <code>Container</code>.</p>
- <p>The <code>ResourceManager</code>, on container allocation provides a
- secure token which is verified by the <code>NodeManager</code> on
- container launch.</p>
- <p>Applications do not need to care about <code>ContainerToken</code>, they
- are transparently handled by the framework - the allocated
- <code>Container</code> includes the <code>ContainerToken</code>.</p>
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
- @return <code>ContainerToken</code> for the container]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>Container</code> represents an allocated resource in the cluster.
- </p>
- <p>The <code>ResourceManager</code> is the sole authority to allocate any
- <code>Container</code> to applications. The allocated <code>Container</code>
- is always on a single node and has a unique {@link ContainerId}. It has
- a specific amount of {@link Resource} allocated.</p>
- <p>It includes details such as:
- <ul>
- <li>{@link ContainerId} for the container, which is globally unique.</li>
- <li>
- {@link NodeId} of the node on which it is allocated.
- </li>
- <li>HTTP uri of the node.</li>
- <li>{@link Resource} allocated to the container.</li>
- <li>{@link Priority} at which the container was allocated.</li>
- <li>
- Container {@link Token} of the container, used to securely verify
- authenticity of the allocation.
- </li>
- </ul>
- </p>
- <p>Typically, an <code>ApplicationMaster</code> receives the
- <code>Container</code> from the <code>ResourceManager</code> during
- resource-negotiation and then talks to the <code>NodeManager</code> to
- start/stop containers.</p>
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)
- @see ContainerManagementProtocol#stopContainers(org.apache.hadoop.yarn.api.protocolrecords.StopContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.Container -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
- <class name="ContainerExitStatus" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerExitStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <field name="SUCCESS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="INVALID" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ABORTED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Containers killed by the framework, either due to being released by
- the application or being 'lost' due to node failures etc.]]>
- </doc>
- </field>
- <field name="DISKS_FAILED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[When threshold number of the nodemanager-local-directories or
- threshold number of the nodemanager-log-directories become bad.]]>
- </doc>
- </field>
- <field name="PREEMPTED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Containers preempted by the framework.]]>
- </doc>
- </field>
- <field name="KILLED_EXCEEDED_VMEM" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container terminated because of exceeding allocated virtual memory.]]>
- </doc>
- </field>
- <field name="KILLED_EXCEEDED_PMEM" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container terminated because of exceeding allocated physical memory.]]>
- </doc>
- </field>
- <field name="KILLED_BY_APPMASTER" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container was terminated by stop request by the app master.]]>
- </doc>
- </field>
- <field name="KILLED_BY_RESOURCEMANAGER" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container was terminated by the resource manager.]]>
- </doc>
- </field>
- <field name="KILLED_AFTER_APP_COMPLETION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container was terminated after the application finished.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[Container exit statuses indicating special exit circumstances.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerExitStatus -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerId -->
- <class name="ContainerId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ContainerId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationAttemptId" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationAttemptId</code> of the application to which the
- <code>Container</code> was assigned.
- <p>
- Note: If containers are kept alive across application attempts via
- {@link ApplicationSubmissionContext#setKeepContainersAcrossApplicationAttempts(boolean)}
- the <code>ContainerId</code> does not necessarily contain the current
- running application attempt's <code>ApplicationAttemptId</code> This
- container can be allocated by previously exited application attempt and
- managed by the current running attempt thus have the previous application
- attempt's <code>ApplicationAttemptId</code>.
- </p>
- @return <code>ApplicationAttemptId</code> of the application to which the
- <code>Container</code> was assigned]]>
- </doc>
- </method>
- <method name="getId" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the lower 32 bits of identifier of the <code>ContainerId</code>,
- which doesn't include epoch. Note that this method will be marked as
- deprecated, so please use <code>getContainerId</code> instead.
- @return lower 32 bits of identifier of the <code>ContainerId</code>]]>
- </doc>
- </method>
- <method name="getContainerId" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the identifier of the <code>ContainerId</code>. Upper 24 bits are
- reserved as epoch of cluster, and lower 40 bits are reserved as
- sequential number of containers.
- @return identifier of the <code>ContainerId</code>]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return A string representation of containerId. The format is
- container_e*epoch*_*clusterTimestamp*_*appId*_*attemptId*_*containerId*
- when epoch is larger than 0
- (e.g. container_e17_1410901177871_0001_01_000005).
- *epoch* is increased when RM restarts or fails over.
- When epoch is 0, epoch is omitted
- (e.g. container_1410901177871_0001_01_000005).]]>
- </doc>
- </method>
- <method name="fromString" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerIdStr" type="java.lang.String"/>
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <field name="CONTAINER_ID_BITMASK" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p><code>ContainerId</code> represents a globally unique identifier
- for a {@link Container} in the cluster.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerId -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
- <class name="ContainerLaunchContext" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerLaunchContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="localResources" type="java.util.Map"/>
- <param name="environment" type="java.util.Map"/>
- <param name="commands" type="java.util.List"/>
- <param name="serviceData" type="java.util.Map"/>
- <param name="tokens" type="java.nio.ByteBuffer"/>
- <param name="acls" type="java.util.Map"/>
- </method>
- <method name="getTokens" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get all the tokens needed by this container. It may include file-system
- tokens, ApplicationMaster related tokens if this container is an
- ApplicationMaster or framework level tokens needed by this container to
- communicate to various services in a secure manner.
- @return tokens needed by this container.]]>
- </doc>
- </method>
- <method name="setTokens"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tokens" type="java.nio.ByteBuffer"/>
- <doc>
- <![CDATA[Set security tokens needed by this container.
- @param tokens security tokens]]>
- </doc>
- </method>
- <method name="getLocalResources" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>LocalResource</code> required by the container.
- @return all <code>LocalResource</code> required by the container]]>
- </doc>
- </method>
- <method name="setLocalResources"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="localResources" type="java.util.Map"/>
- <doc>
- <![CDATA[Set <code>LocalResource</code> required by the container. All pre-existing
- Map entries are cleared before adding the new Map
- @param localResources <code>LocalResource</code> required by the container]]>
- </doc>
- </method>
- <method name="getServiceData" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Get application-specific binary <em>service data</em>. This is a map keyed
- by the name of each {@link AuxiliaryService} that is configured on a
- NodeManager and value correspond to the application specific data targeted
- for the keyed {@link AuxiliaryService}.
- </p>
- <p>
- This will be used to initialize this application on the specific
- {@link AuxiliaryService} running on the NodeManager by calling
- {@link AuxiliaryService#initializeApplication(ApplicationInitializationContext)}
- </p>
- @return application-specific binary <em>service data</em>]]>
- </doc>
- </method>
- <method name="setServiceData"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="serviceData" type="java.util.Map"/>
- <doc>
- <![CDATA[<p>
- Set application-specific binary <em>service data</em>. This is a map keyed
- by the name of each {@link AuxiliaryService} that is configured on a
- NodeManager and value correspond to the application specific data targeted
- for the keyed {@link AuxiliaryService}. All pre-existing Map entries are
- preserved.
- </p>
- @param serviceData
- application-specific binary <em>service data</em>]]>
- </doc>
- </method>
- <method name="getEnvironment" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>environment variables</em> for the container.
- @return <em>environment variables</em> for the container]]>
- </doc>
- </method>
- <method name="setEnvironment"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="environment" type="java.util.Map"/>
- <doc>
- <![CDATA[Add <em>environment variables</em> for the container. All pre-existing Map
- entries are cleared before adding the new Map
- @param environment <em>environment variables</em> for the container]]>
- </doc>
- </method>
- <method name="getCommands" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <em>commands</em> for launching the container.
- @return the list of <em>commands</em> for launching the container]]>
- </doc>
- </method>
- <method name="setCommands"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="commands" type="java.util.List"/>
- <doc>
- <![CDATA[Add the list of <em>commands</em> for launching the container. All
- pre-existing List entries are cleared before adding the new List
- @param commands the list of <em>commands</em> for launching the container]]>
- </doc>
- </method>
- <method name="getApplicationACLs" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ApplicationACL</code>s for the application.
- @return all the <code>ApplicationACL</code>s]]>
- </doc>
- </method>
- <method name="setApplicationACLs"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="acls" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the <code>ApplicationACL</code>s for the application. All pre-existing
- Map entries are cleared before adding the new Map
- @param acls <code>ApplicationACL</code>s for the application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>ContainerLaunchContext</code> represents all of the information
- needed by the <code>NodeManager</code> to launch a container.</p>
- <p>It includes details such as:
- <ul>
- <li>{@link ContainerId} of the container.</li>
- <li>{@link Resource} allocated to the container.</li>
- <li>User to whom the container is allocated.</li>
- <li>Security tokens (if security is enabled).</li>
- <li>
- {@link LocalResource} necessary for running the container such
- as binaries, jar, shared-objects, side-files etc.
- </li>
- <li>Optional, application-specific binary service data.</li>
- <li>Environment variables for the launched process.</li>
- <li>Command to launch the container.</li>
- </ul>
- </p>
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerLaunchContext -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerReport -->
- <class name="ContainerReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code> of the container.
- @return <code>ContainerId</code> of the container.]]>
- </doc>
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getAllocatedResource" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the allocated <code>Resource</code> of the container.
- @return allocated <code>Resource</code> of the container.]]>
- </doc>
- </method>
- <method name="setAllocatedResource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="getAssignedNode" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the allocated <code>NodeId</code> where container is running.
- @return allocated <code>NodeId</code> where container is running.]]>
- </doc>
- </method>
- <method name="setAssignedNode"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
- </method>
- <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the allocated <code>Priority</code> of the container.
- @return allocated <code>Priority</code> of the container.]]>
- </doc>
- </method>
- <method name="setPriority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- </method>
- <method name="getCreationTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the creation time of the container.
- @return creation time of the container]]>
- </doc>
- </method>
- <method name="setCreationTime"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="creationTime" type="long"/>
- </method>
- <method name="getFinishTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Finish time of the container.
- @return Finish time of the container]]>
- </doc>
- </method>
- <method name="setFinishTime"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="finishTime" type="long"/>
- </method>
- <method name="getDiagnosticsInfo" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the DiagnosticsInfo of the container.
- @return DiagnosticsInfo of the container]]>
- </doc>
- </method>
- <method name="setDiagnosticsInfo"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="diagnosticsInfo" type="java.lang.String"/>
- </method>
- <method name="getLogUrl" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the LogURL of the container.
- @return LogURL of the container]]>
- </doc>
- </method>
- <method name="setLogUrl"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logUrl" type="java.lang.String"/>
- </method>
- <method name="getContainerState" return="org.apache.hadoop.yarn.api.records.ContainerState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the final <code>ContainerState</code> of the container.
- @return final <code>ContainerState</code> of the container.]]>
- </doc>
- </method>
- <method name="setContainerState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerState" type="org.apache.hadoop.yarn.api.records.ContainerState"/>
- </method>
- <method name="getContainerExitStatus" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the final <code>exit status</code> of the container.
- @return final <code>exit status</code> of the container.]]>
- </doc>
- </method>
- <method name="setContainerExitStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerExitStatus" type="int"/>
- </method>
- <doc>
- <![CDATA[<p>
- <code>ContainerReport</code> is a report of an container.
- </p>
- <p>
- It includes details such as:
- <ul>
- <li>{@link ContainerId} of the container.</li>
- <li>Allocated Resources to the container.</li>
- <li>Assigned Node id.</li>
- <li>Assigned Priority.</li>
- <li>Creation Time.</li>
- <li>Finish Time.</li>
- <li>Container Exit Status.</li>
- <li>{@link ContainerState} of the container.</li>
- <li>Diagnostic information in case of errors.</li>
- <li>Log URL.</li>
- </ul>
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceDecrease -->
- <class name="ContainerResourceDecrease" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerResourceDecrease"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceDecrease"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[Used by Application Master to ask Node Manager reduce size of a specified
- container]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceDecrease -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceIncrease -->
- <class name="ContainerResourceIncrease" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerResourceIncrease"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceIncrease"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="getContainerToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerToken"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[Represent a new increased container accepted by Resource Manager]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceIncrease -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
- <class name="ContainerResourceIncreaseRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerResourceIncreaseRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="existingContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[Used by Application Master, send a container resource increase request to
- Resource Manager]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerResourceIncreaseRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerState -->
- <class name="ContainerState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.ContainerState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ContainerState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[<p>State of a <code>Container</code>.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerState -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerStatus -->
- <class name="ContainerStatus" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerId</code> of the container.
- @return <code>ContainerId</code> of the container]]>
- </doc>
- </method>
- <method name="getState" return="org.apache.hadoop.yarn.api.records.ContainerState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerState</code> of the container.
- @return <code>ContainerState</code> of the container]]>
- </doc>
- </method>
- <method name="getExitStatus" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>Get the <em>exit status</em> for the container.</p>
- <p>Note: This is valid only for completed containers i.e. containers
- with state {@link ContainerState#COMPLETE}.
- Otherwise, it returns an ContainerExitStatus.INVALID.
- </p>
- <p>Containers killed by the framework, either due to being released by
- the application or being 'lost' due to node failures etc. have a special
- exit code of ContainerExitStatus.ABORTED.</p>
- <p>When threshold number of the nodemanager-local-directories or
- threshold number of the nodemanager-log-directories become bad, then
- container is not launched and is exited with ContainersExitStatus.DISKS_FAILED.
- </p>
- @return <em>exit status</em> for the container]]>
- </doc>
- </method>
- <method name="getDiagnostics" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>diagnostic messages</em> for failed containers.
- @return <em>diagnostic messages</em> for failed containers]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>ContainerStatus</code> represents the current status of a
- <code>Container</code>.</p>
- <p>It provides details such as:
- <ul>
- <li><code>ContainerId</code> of the container.</li>
- <li><code>ContainerState</code> of the container.</li>
- <li><em>Exit status</em> of a completed container.</li>
- <li><em>Diagnostic</em> message for a failed container.</li>
- </ul>
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
- <!-- start class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
- <class name="FinalApplicationStatus" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.FinalApplicationStatus"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration of various final states of an <code>Application</code>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.FinalApplicationStatus -->
- <!-- start class org.apache.hadoop.yarn.api.records.LocalResource -->
- <class name="LocalResource" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LocalResource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
- <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
- <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
- <param name="size" type="long"/>
- <param name="timestamp" type="long"/>
- <param name="pattern" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalResource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="url" type="org.apache.hadoop.yarn.api.records.URL"/>
- <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
- <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
- <param name="size" type="long"/>
- <param name="timestamp" type="long"/>
- </method>
- <method name="getResource" return="org.apache.hadoop.yarn.api.records.URL"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>location</em> of the resource to be localized.
- @return <em>location</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="setResource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="org.apache.hadoop.yarn.api.records.URL"/>
- <doc>
- <![CDATA[Set <em>location</em> of the resource to be localized.
- @param resource <em>location</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="getSize" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>size</em> of the resource to be localized.
- @return <em>size</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="setSize"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="size" type="long"/>
- <doc>
- <![CDATA[Set the <em>size</em> of the resource to be localized.
- @param size <em>size</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="getTimestamp" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the original <em>timestamp</em> of the resource to be localized, used
- for verification.
- @return <em>timestamp</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="setTimestamp"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timestamp" type="long"/>
- <doc>
- <![CDATA[Set the <em>timestamp</em> of the resource to be localized, used
- for verification.
- @param timestamp <em>timestamp</em> of the resource to be localized]]>
- </doc>
- </method>
- <method name="getType" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>LocalResourceType</code> of the resource to be localized.
- @return <code>LocalResourceType</code> of the resource to be localized]]>
- </doc>
- </method>
- <method name="setType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="org.apache.hadoop.yarn.api.records.LocalResourceType"/>
- <doc>
- <![CDATA[Set the <code>LocalResourceType</code> of the resource to be localized.
- @param type <code>LocalResourceType</code> of the resource to be localized]]>
- </doc>
- </method>
- <method name="getVisibility" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>LocalResourceVisibility</code> of the resource to be
- localized.
- @return <code>LocalResourceVisibility</code> of the resource to be
- localized]]>
- </doc>
- </method>
- <method name="setVisibility"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="visibility" type="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"/>
- <doc>
- <![CDATA[Set the <code>LocalResourceVisibility</code> of the resource to be
- localized.
- @param visibility <code>LocalResourceVisibility</code> of the resource to be
- localized]]>
- </doc>
- </method>
- <method name="getPattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>pattern</em> that should be used to extract entries from the
- archive (only used when type is <code>PATTERN</code>).
- @return <em>pattern</em> that should be used to extract entries from the
- archive.]]>
- </doc>
- </method>
- <method name="setPattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <em>pattern</em> that should be used to extract entries from the
- archive (only used when type is <code>PATTERN</code>).
- @param pattern <em>pattern</em> that should be used to extract entries
- from the archive.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>LocalResource</code> represents a local resource required to
- run a container.</p>
- <p>The <code>NodeManager</code> is responsible for localizing the resource
- prior to launching the container.</p>
- <p>Applications can specify {@link LocalResourceType} and
- {@link LocalResourceVisibility}.</p>
- @see LocalResourceType
- @see LocalResourceVisibility
- @see ContainerLaunchContext
- @see ApplicationSubmissionContext
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LocalResource -->
- <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceType -->
- <class name="LocalResourceType" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceType[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceType"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[<p><code>LocalResourceType</code> specifies the <em>type</em>
- of a resource localized by the <code>NodeManager</code>.</p>
- <p>The <em>type</em> can be one of:
- <ul>
- <li>
- {@link #FILE} - Regular file i.e. uninterpreted bytes.
- </li>
- <li>
- {@link #ARCHIVE} - Archive, which is automatically unarchived by the
- <code>NodeManager</code>.
- </li>
- <li>
- {@link #PATTERN} - A hybrid between {@link #ARCHIVE} and {@link #FILE}.
- </ul>
- </p>
- @see LocalResource
- @see ContainerLaunchContext
- @see ApplicationSubmissionContext
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceType -->
- <!-- start class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
- <class name="LocalResourceVisibility" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.LocalResourceVisibility"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[<p><code>LocalResourceVisibility</code> specifies the <em>visibility</em>
- of a resource localized by the <code>NodeManager</code>.</p>
- <p>The <em>visibility</em> can be one of:
- <ul>
- <li>{@link #PUBLIC} - Shared by all users on the node.</li>
- <li>
- {@link #PRIVATE} - Shared among all applications of the
- <em>same user</em> on the node.
- </li>
- <li>
- {@link #APPLICATION} - Shared only among containers of the
- <em>same application</em> on the node.
- </li>
- </ul>
- </p>
- @see LocalResource
- @see ContainerLaunchContext
- @see ApplicationSubmissionContext
- @see ContainerManagementProtocol#startContainers(org.apache.hadoop.yarn.api.protocolrecords.StartContainersRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LocalResourceVisibility -->
- <!-- start class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
- <class name="LogAggregationContext" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LogAggregationContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LogAggregationContext"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includePattern" type="java.lang.String"/>
- <param name="excludePattern" type="java.lang.String"/>
- </method>
- <method name="getIncludePattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get include pattern
- @return include pattern]]>
- </doc>
- </method>
- <method name="setIncludePattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includePattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set include pattern
- @param includePattern]]>
- </doc>
- </method>
- <method name="getExcludePattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get exclude pattern
- @return exclude pattern]]>
- </doc>
- </method>
- <method name="setExcludePattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="excludePattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set exclude pattern
- @param excludePattern]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>LogAggregationContext</code> represents all of the
- information needed by the <code>NodeManager</code> to handle
- the logs for an application.</p>
- <p>It includes details such as:
- <ul>
- <li>includePattern. It uses Java Regex to filter the log files
- which match the defined include pattern and those log files
- will be uploaded. </li>
- <li>excludePattern. It uses Java Regex to filter the log files
- which match the defined exclude pattern and those log files
- will not be uploaded. If the log file name matches both the
- include and the exclude pattern, this file will be excluded eventually</li>
- </ul>
- </p>
- @see ApplicationSubmissionContext]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LogAggregationContext -->
- <!-- start class org.apache.hadoop.yarn.api.records.NMToken -->
- <class name="NMToken" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NMToken"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link NodeId} of the <code>NodeManager</code> for which the NMToken
- is used to authenticate.
- @return the {@link NodeId} of the <code>NodeManager</code> for which the
- NMToken is used to authenticate.]]>
- </doc>
- </method>
- <method name="setNodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeId" type="org.apache.hadoop.yarn.api.records.NodeId"/>
- </method>
- <method name="getToken" return="org.apache.hadoop.yarn.api.records.Token"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link Token} used for authenticating with <code>NodeManager</code>
- @return the {@link Token} used for authenticating with <code>NodeManager</code>]]>
- </doc>
- </method>
- <method name="setToken"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[<p>The NMToken is used for authenticating communication with
- <code>NodeManager</code></p>
- <p>It is issued by <code>ResourceMananger</code> when <code>ApplicationMaster</code>
- negotiates resource with <code>ResourceManager</code> and
- validated on <code>NodeManager</code> side.</p>
- @see AllocateResponse#getNMTokens()]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NMToken -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeId -->
- <class name="NodeId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="NodeId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>hostname</em> of the node.
- @return <em>hostname</em> of the node]]>
- </doc>
- </method>
- <method name="getPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>port</em> for communicating with the node.
- @return <em>port</em> for communicating with the node]]>
- </doc>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.NodeId"/>
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p><code>NodeId</code> is the unique identifier for a node.</p>
- <p>It includes the <em>hostname</em> and <em>port</em> to uniquely
- identify the node. Thus, it is unique across restarts of any
- <code>NodeManager</code>.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeId -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeReport -->
- <class name="NodeReport" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NodeReport"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNodeId" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>NodeId</code> of the node.
- @return <code>NodeId</code> of the node]]>
- </doc>
- </method>
- <method name="getNodeState" return="org.apache.hadoop.yarn.api.records.NodeState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>NodeState</code> of the node.
- @return <code>NodeState</code> of the node]]>
- </doc>
- </method>
- <method name="getHttpAddress" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>http address</em> of the node.
- @return <em>http address</em> of the node]]>
- </doc>
- </method>
- <method name="getRackName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>rack name</em> for the node.
- @return <em>rack name</em> for the node]]>
- </doc>
- </method>
- <method name="getUsed" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>used</em> <code>Resource</code> on the node.
- @return <em>used</em> <code>Resource</code> on the node]]>
- </doc>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>total</em> <code>Resource</code> on the node.
- @return <em>total</em> <code>Resource</code> on the node]]>
- </doc>
- </method>
- <method name="getHealthReport" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>diagnostic health report</em> of the node.
- @return <em>diagnostic health report</em> of the node]]>
- </doc>
- </method>
- <method name="getLastHealthReportTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>last timestamp</em> at which the health report was received.
- @return <em>last timestamp</em> at which the health report was received]]>
- </doc>
- </method>
- <method name="getNodeLabels" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get labels of this node
- @return labels of this node]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>NodeReport</code> is a summary of runtime information of a
- node in the cluster.</p>
- <p>It includes details such as:
- <ul>
- <li>{@link NodeId} of the node.</li>
- <li>HTTP Tracking URL of the node.</li>
- <li>Rack name for the node.</li>
- <li>Used {@link Resource} on the node.</li>
- <li>Total available {@link Resource} of the node.</li>
- <li>Number of running containers on the node.</li>
- </ul>
- </p>
- @see ApplicationClientProtocol#getClusterNodes(org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeState -->
- <class name="NodeState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.NodeState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.NodeState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="isUnusable" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p>State of a <code>Node</code>.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeState -->
- <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
- <class name="PreemptionContainer" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PreemptionContainer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Container referenced by this handle.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Specific container requested back by the <code>ResourceManager</code>.
- @see PreemptionContract
- @see StrictPreemptionContract]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContainer -->
- <!-- start class org.apache.hadoop.yarn.api.records.PreemptionContract -->
- <class name="PreemptionContract" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PreemptionContract"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getResourceRequest" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If the AM releases resources matching these requests, then the {@link
- PreemptionContainer}s enumerated in {@link #getContainers()} should not be
- evicted from the cluster. Due to delays in propagating cluster state and
- sending these messages, there are conditions where satisfied contracts may
- not prevent the platform from killing containers.
- @return List of {@link PreemptionResourceRequest} to update the
- <code>ApplicationMaster</code> about resources requested back by the
- <code>ResourceManager</code>.
- @see AllocateRequest#setAskList(List)]]>
- </doc>
- </method>
- <method name="getContainers" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Assign the set of {@link PreemptionContainer} specifying which containers
- owned by the <code>ApplicationMaster</code> that may be reclaimed by the
- <code>ResourceManager</code>. If the AM prefers a different set of
- containers, then it may checkpoint or kill containers matching the
- description in {@link #getResourceRequest}.
- @return Set of containers at risk if the contract is not met.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Description of resources requested back by the <code>ResourceManager</code>.
- The <code>ApplicationMaster</code> (AM) can satisfy this request according
- to its own priorities to prevent containers from being forcibly killed by
- the platform.
- @see PreemptionMessage]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.PreemptionContract -->
- <!-- start class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
- <class name="PreemptionMessage" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PreemptionMessage"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getStrictContract" return="org.apache.hadoop.yarn.api.records.StrictPreemptionContract"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Specific resources that may be killed by the
- <code>ResourceManager</code>]]>
- </doc>
- </method>
- <method name="getContract" return="org.apache.hadoop.yarn.api.records.PreemptionContract"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Contract describing resources to return to the cluster.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>A {@link PreemptionMessage} is part of the RM-AM protocol, and it is used by
- the RM to specify resources that the RM wants to reclaim from this
- <code>ApplicationMaster</code> (AM). The AM receives a {@link
- StrictPreemptionContract} message encoding which containers the platform may
- forcibly kill, granting it an opportunity to checkpoint state or adjust its
- execution plan. The message may also include a {@link PreemptionContract}
- granting the AM more latitude in selecting which resources to return to the
- cluster.<p>
- <p>The AM should decode both parts of the message. The {@link
- StrictPreemptionContract} specifies particular allocations that the RM
- requires back. The AM can checkpoint containers' state, adjust its execution
- plan to move the computation, or take no action and hope that conditions that
- caused the RM to ask for the container will change.<p>
- <p>In contrast, the {@link PreemptionContract} also includes a description of
- resources with a set of containers. If the AM releases containers matching
- that profile, then the containers enumerated in {@link
- PreemptionContract#getContainers()} may not be killed.<p>
- <p>Each preemption message reflects the RM's current understanding of the
- cluster state, so a request to return <emph>N</emph> containers may not
- reflect containers the AM is releasing, recently exited containers the RM has
- yet to learn about, or new containers allocated before the message was
- generated. Conversely, an RM may request a different profile of containers in
- subsequent requests.<p>
- <p>The policy enforced by the RM is part of the scheduler. Generally, only
- containers that have been requested consistently should be killed, but the
- details are not specified.<p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.PreemptionMessage -->
- <!-- start class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
- <class name="PreemptionResourceRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PreemptionResourceRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getResourceRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return Resource described in this request, to be matched against running
- containers.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Description of resources requested back by the cluster.
- @see PreemptionContract
- @see AllocateRequest#setAskList(java.util.List)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.PreemptionResourceRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.Priority -->
- <class name="Priority" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Priority"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="int"/>
- </method>
- <method name="getPriority" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the assigned priority
- @return the assigned priority]]>
- </doc>
- </method>
- <method name="setPriority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="int"/>
- <doc>
- <![CDATA[Set the assigned priority
- @param priority the assigned priority]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.Priority"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="UNDEFINED" type="org.apache.hadoop.yarn.api.records.Priority"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The priority assigned to a ResourceRequest or Application or Container
- allocation]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.Priority -->
- <!-- start class org.apache.hadoop.yarn.api.records.QueueACL -->
- <class name="QueueACL" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.QueueACL[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueACL"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[<p>
- <code>QueueACL</code> enumerates the various ACLs for queues.
- </p>
- <p>
- The ACL is one of:
- <ul>
- <li>{@link #SUBMIT_APPLICATIONS} - ACL to submit applications to the
- queue.</li>
- <li>{@link #ADMINISTER_QUEUE} - ACL to administer the queue.</li>
- </ul>
- </p>
- @see QueueInfo
- @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.QueueACL -->
- <!-- start class org.apache.hadoop.yarn.api.records.QueueInfo -->
- <class name="QueueInfo" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="QueueInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getQueueName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>name</em> of the queue.
- @return <em>name</em> of the queue]]>
- </doc>
- </method>
- <method name="getCapacity" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>configured capacity</em> of the queue.
- @return <em>configured capacity</em> of the queue]]>
- </doc>
- </method>
- <method name="getMaximumCapacity" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>maximum capacity</em> of the queue.
- @return <em>maximum capacity</em> of the queue]]>
- </doc>
- </method>
- <method name="getCurrentCapacity" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>current capacity</em> of the queue.
- @return <em>current capacity</em> of the queue]]>
- </doc>
- </method>
- <method name="getChildQueues" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>child queues</em> of the queue.
- @return <em>child queues</em> of the queue]]>
- </doc>
- </method>
- <method name="getApplications" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>running applications</em> of the queue.
- @return <em>running applications</em> of the queue]]>
- </doc>
- </method>
- <method name="getQueueState" return="org.apache.hadoop.yarn.api.records.QueueState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>QueueState</code> of the queue.
- @return <code>QueueState</code> of the queue]]>
- </doc>
- </method>
- <method name="getAccessibleNodeLabels" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>accessible node labels</code> of the queue.
- @return <code>accessible node labels</code> of the queue]]>
- </doc>
- </method>
- <method name="getDefaultNodeLabelExpression" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>default node label expression</code> of the queue, this takes
- affect only when the <code>ApplicationSubmissionContext</code> and
- <code>ResourceRequest</code> don't specify their
- <code>NodeLabelExpression</code>.
- @return <code>default node label expression</code> of the queue]]>
- </doc>
- </method>
- <method name="setDefaultNodeLabelExpression"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="defaultLabelExpression" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[<p>QueueInfo is a report of the runtime information of the queue.</p>
- <p>It includes information such as:
- <ul>
- <li>Queue name.</li>
- <li>Capacity of the queue.</li>
- <li>Maximum capacity of the queue.</li>
- <li>Current capacity of the queue.</li>
- <li>Child queues.</li>
- <li>Running applications.</li>
- <li>{@link QueueState} of the queue.</li>
- </ul>
- </p>
- @see QueueState
- @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.QueueInfo -->
- <!-- start class org.apache.hadoop.yarn.api.records.QueueState -->
- <class name="QueueState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.QueueState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.QueueState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[<p>State of a Queue.</p>
- <p>A queue is in one of:
- <ul>
- <li>{@link #RUNNING} - normal state.</li>
- <li>{@link #STOPPED} - not accepting new application submissions.
- </ul>
- </p>
- @see QueueInfo
- @see ApplicationClientProtocol#getQueueInfo(org.apache.hadoop.yarn.api.protocolrecords.GetQueueInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.QueueState -->
- <!-- start class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
- <class name="QueueUserACLInfo" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="QueueUserACLInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getQueueName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>queue name</em> of the queue.
- @return <em>queue name</em> of the queue]]>
- </doc>
- </method>
- <method name="getUserAcls" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of <code>QueueACL</code> for the given user.
- @return list of <code>QueueACL</code> for the given user]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>QueueUserACLInfo</code> provides information {@link QueueACL} for
- the given user.</p>
- @see QueueACL
- @see ApplicationClientProtocol#getQueueUserAcls(org.apache.hadoop.yarn.api.protocolrecords.GetQueueUserAclsInfoRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.QueueUserACLInfo -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
- <class name="ReservationDefinition" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationDefinition"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationDefinition"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="arrival" type="long"/>
- <param name="deadline" type="long"/>
- <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getArrival" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the arrival time or the earliest time from which the resource(s) can be
- allocated. Time expressed as UTC.
- @return the earliest valid time for this reservation]]>
- </doc>
- </method>
- <method name="setArrival"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="earliestStartTime" type="long"/>
- <doc>
- <![CDATA[Set the arrival time or the earliest time from which the resource(s) can be
- allocated. Time expressed as UTC.
- @param earliestStartTime the earliest valid time for this reservation]]>
- </doc>
- </method>
- <method name="getDeadline" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the deadline or the latest time by when the resource(s) must be
- allocated. Time expressed as UTC.
- @return the deadline or the latest time by when the resource(s) must be
- allocated]]>
- </doc>
- </method>
- <method name="setDeadline"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="latestEndTime" type="long"/>
- <doc>
- <![CDATA[Set the deadline or the latest time by when the resource(s) must be
- allocated. Time expressed as UTC.
- @param latestEndTime the deadline or the latest time by when the
- resource(s) should be allocated]]>
- </doc>
- </method>
- <method name="getReservationRequests" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of {@link ReservationRequests} representing the resources
- required by the application
- @return the list of {@link ReservationRequests}]]>
- </doc>
- </method>
- <method name="setReservationRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationRequests" type="org.apache.hadoop.yarn.api.records.ReservationRequests"/>
- <doc>
- <![CDATA[Set the list of {@link ReservationRequests} representing the resources
- required by the application
- @param reservationRequests the list of {@link ReservationRequests}]]>
- </doc>
- </method>
- <method name="getReservationName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the name for this reservation. The name need-not be unique, and it is
- just a mnemonic for the user (akin to job names). Accepted reservations are
- uniquely identified by a system-generated ReservationId.
- @return string representing the name of the corresponding reserved resource
- allocation in the scheduler]]>
- </doc>
- </method>
- <method name="setReservationName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the name for this reservation. The name need-not be unique, and it is
- just a mnemonic for the user (akin to job names). Accepted reservations are
- uniquely identified by a system-generated ReservationId.
- @param name representing the name of the corresponding reserved resource
- allocation in the scheduler]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationDefinition} captures the set of resource and time
- constraints the user cares about regarding a reservation.
- @see ResourceRequest]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationDefinition -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationId -->
- <class name="ReservationId" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ReservationId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the long identifier of the {@link ReservationId} which is unique for
- all Reservations started by a particular instance of the
- {@code ResourceManager}.
- @return long identifier of the {@link ReservationId}]]>
- </doc>
- </method>
- <method name="getClusterTimestamp" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>start time</em> of the {@code ResourceManager} which is used to
- generate globally unique {@link ReservationId}.
- @return <em>start time</em> of the {@code ResourceManager}]]>
- </doc>
- </method>
- <method name="build"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="parseReservationId" return="org.apache.hadoop.yarn.api.records.ReservationId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationId" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Parse the string argument as a {@link ReservationId}
- @param reservationId the string representation of the {@link ReservationId}
- @return the {@link ReservationId} corresponding to the input string if
- valid, null if input is null
- @throws IOException if unable to parse the input string]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <field name="reserveIdStrPrefix" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="clusterTimestamp" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="id" type="long"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p>
- {@link ReservationId} represents the <em>globally unique</em> identifier for
- a reservation.
- </p>
- <p>
- The globally unique nature of the identifier is achieved by using the
- <em>cluster timestamp</em> i.e. start-time of the {@code ResourceManager}
- along with a monotonically increasing counter for the reservation.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationId -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest -->
- <class name="ReservationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ReservationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- <param name="concurrency" type="int"/>
- <param name="duration" type="long"/>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link Resource} capability of the request.
- @return {@link Resource} capability of the request]]>
- </doc>
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <doc>
- <![CDATA[Set the {@link Resource} capability of the request
- @param capability {@link Resource} capability of the request]]>
- </doc>
- </method>
- <method name="getNumContainers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of containers required with the given specifications.
- @return number of containers required with the given specifications]]>
- </doc>
- </method>
- <method name="setNumContainers"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numContainers" type="int"/>
- <doc>
- <![CDATA[Set the number of containers required with the given specifications
- @param numContainers number of containers required with the given
- specifications]]>
- </doc>
- </method>
- <method name="getConcurrency" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of containers that need to be scheduled concurrently. The
- default value of 1 would fall back to the current non concurrency
- constraints on the scheduling behavior.
- @return the number of containers to be concurrently scheduled]]>
- </doc>
- </method>
- <method name="setConcurrency"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numContainers" type="int"/>
- <doc>
- <![CDATA[Set the number of containers that need to be scheduled concurrently. The
- default value of 1 would fall back to the current non concurrency
- constraints on the scheduling behavior.
- @param numContainers the number of containers to be concurrently scheduled]]>
- </doc>
- </method>
- <method name="getDuration" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the duration in milliseconds for which the resource is required. A
- default value of -1, indicates an unspecified lease duration, and fallback
- to current behavior.
- @return the duration in milliseconds for which the resource is required]]>
- </doc>
- </method>
- <method name="setDuration"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="duration" type="long"/>
- <doc>
- <![CDATA[Set the duration in milliseconds for which the resource is required.
- @param duration the duration in milliseconds for which the resource is
- required]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
- </method>
- <doc>
- <![CDATA[<p>
- {@link ReservationRequest} represents the request made by an application to
- the {@code ResourceManager} to reserve {@link Resource}s.
- </p>
- <p>
- It includes:
- <ul>
- <li>{@link Resource} required for each request.</li>
- <li>
- Number of containers, of above specifications, which are required by the
- application.</li>
- <li>
- Concurrency that indicates the gang size of the request.</li>
- </ul>
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
- <class name="ReservationRequest.ReservationRequestComparator" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.Comparator"/>
- <implements name="java.io.Serializable"/>
- <constructor name="ReservationRequest.ReservationRequestComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r1" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
- <param name="r2" type="org.apache.hadoop.yarn.api.records.ReservationRequest"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequest.ReservationRequestComparator -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
- <class name="ReservationRequestInterpreter" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration of various types of dependencies among multiple
- {@link ReservationRequests} within one {@link ReservationDefinition} (from
- least constraining to most constraining).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationRequests -->
- <class name="ReservationRequests" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationRequests"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationRequests"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationResources" type="java.util.List"/>
- <param name="type" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
- </method>
- <method name="getReservationResources" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of {@link ReservationRequest} representing the resources
- required by the application
- @return the list of {@link ReservationRequest}]]>
- </doc>
- </method>
- <method name="setReservationResources"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationResources" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list of {@link ReservationRequest} representing the resources
- required by the application
- @param reservationResources the list of {@link ReservationRequest}]]>
- </doc>
- </method>
- <method name="getInterpreter" return="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@link ReservationRequestInterpreter}, representing how the list of
- resources should be allocated, this captures temporal ordering and other
- constraints.
- @return the list of {@link ReservationRequestInterpreter}]]>
- </doc>
- </method>
- <method name="setInterpreter"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="interpreter" type="org.apache.hadoop.yarn.api.records.ReservationRequestInterpreter"/>
- <doc>
- <![CDATA[Set the {@link ReservationRequestInterpreter}, representing how the list of
- resources should be allocated, this captures temporal ordering and other
- constraints.
- @param interpreter the {@link ReservationRequestInterpreter} for this
- reservation]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationRequests} captures the set of resource and constraints the
- user cares about regarding a reservation.
- @see ReservationRequest]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationRequests -->
- <!-- start class org.apache.hadoop.yarn.api.records.Resource -->
- <class name="Resource" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="Resource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memory" type="int"/>
- <param name="vCores" type="int"/>
- </method>
- <method name="getMemory" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>memory</em> of the resource.
- @return <em>memory</em> of the resource]]>
- </doc>
- </method>
- <method name="setMemory"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memory" type="int"/>
- <doc>
- <![CDATA[Set <em>memory</em> of the resource.
- @param memory <em>memory</em> of the resource]]>
- </doc>
- </method>
- <method name="getVirtualCores" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>number of virtual cpu cores</em> of the resource.
- Virtual cores are a unit for expressing CPU parallelism. A node's capacity
- should be configured with virtual cores equal to its number of physical cores.
- A container should be requested with the number of cores it can saturate, i.e.
- the average number of threads it expects to have runnable at a time.
- @return <em>num of virtual cpu cores</em> of the resource]]>
- </doc>
- </method>
- <method name="setVirtualCores"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="vCores" type="int"/>
- <doc>
- <![CDATA[Set <em>number of virtual cpu cores</em> of the resource.
- Virtual cores are a unit for expressing CPU parallelism. A node's capacity
- should be configured with virtual cores equal to its number of physical cores.
- A container should be requested with the number of cores it can saturate, i.e.
- the average number of threads it expects to have runnable at a time.
- @param vCores <em>number of virtual cpu cores</em> of the resource]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[<p><code>Resource</code> models a set of computer resources in the
- cluster.</p>
- <p>Currently it models both <em>memory</em> and <em>CPU</em>.</p>
- <p>The unit for memory is megabytes. CPU is modeled with virtual cores
- (vcores), a unit for expressing parallelism. A node's capacity should
- be configured with virtual cores equal to its number of physical cores. A
- container should be requested with the number of cores it can saturate, i.e.
- the average number of threads it expects to have runnable at a time.</p>
- <p>Virtual cores take integer values and thus currently CPU-scheduling is
- very coarse. A complementary axis for CPU requests that represents processing
- power will likely be added in the future to enable finer-grained resource
- configuration.</p>
- <p>Typically, applications request <code>Resource</code> of suitable
- capability to run their component tasks.</p>
- @see ResourceRequest
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.Resource -->
- <!-- start class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
- <class name="ResourceBlacklistRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceBlacklistRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="additions" type="java.util.List"/>
- <param name="removals" type="java.util.List"/>
- </method>
- <method name="getBlacklistAdditions" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of resource-names which should be added to the
- application blacklist.
- @return list of resource-names which should be added to the
- application blacklist]]>
- </doc>
- </method>
- <method name="setBlacklistAdditions"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceNames" type="java.util.List"/>
- <doc>
- <![CDATA[Set list of resource-names which should be added to the application blacklist.
- @param resourceNames list of resource-names which should be added to the
- application blacklist]]>
- </doc>
- </method>
- <method name="getBlacklistRemovals" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of resource-names which should be removed from the
- application blacklist.
- @return list of resource-names which should be removed from the
- application blacklist]]>
- </doc>
- </method>
- <method name="setBlacklistRemovals"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceNames" type="java.util.List"/>
- <doc>
- <![CDATA[Set list of resource-names which should be removed from the
- application blacklist.
- @param resourceNames list of resource-names which should be removed from the
- application blacklist]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ResourceBlacklistRequest} encapsulates the list of resource-names
- which should be added or removed from the <em>blacklist</em> of resources
- for the application.
- @see ResourceRequest
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.ResourceOption -->
- <class name="ResourceOption" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceOption"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceOption"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="overCommitTimeout" type="int"/>
- </method>
- <method name="toString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceOption -->
- <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest -->
- <class name="ResourceRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ResourceRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- <param name="relaxLocality" type="boolean"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="hostName" type="java.lang.String"/>
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="numContainers" type="int"/>
- <param name="relaxLocality" type="boolean"/>
- <param name="labelExpression" type="java.lang.String"/>
- </method>
- <method name="isAnyLocation" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostName" type="java.lang.String"/>
- <doc>
- <![CDATA[Check whether the given <em>host/rack</em> string represents an arbitrary
- host name.
- @param hostName <em>host/rack</em> on which the allocation is desired
- @return whether the given <em>host/rack</em> string represents an arbitrary
- host name]]>
- </doc>
- </method>
- <method name="getPriority" return="org.apache.hadoop.yarn.api.records.Priority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Priority</code> of the request.
- @return <code>Priority</code> of the request]]>
- </doc>
- </method>
- <method name="setPriority"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <doc>
- <![CDATA[Set the <code>Priority</code> of the request
- @param priority <code>Priority</code> of the request]]>
- </doc>
- </method>
- <method name="getResourceName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the resource (e.g. <em>host/rack</em>) on which the allocation
- is desired.
- A special value of <em>*</em> signifies that <em>any</em> resource
- (host/rack) is acceptable.
- @return resource (e.g. <em>host/rack</em>) on which the allocation
- is desired]]>
- </doc>
- </method>
- <method name="setResourceName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the resource name (e.g. <em>host/rack</em>) on which the allocation
- is desired.
- A special value of <em>*</em> signifies that <em>any</em> resource name
- (e.g. host/rack) is acceptable.
- @param resourceName (e.g. <em>host/rack</em>) on which the
- allocation is desired]]>
- </doc>
- </method>
- <method name="getCapability" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Resource</code> capability of the request.
- @return <code>Resource</code> capability of the request]]>
- </doc>
- </method>
- <method name="setCapability"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <doc>
- <![CDATA[Set the <code>Resource</code> capability of the request
- @param capability <code>Resource</code> capability of the request]]>
- </doc>
- </method>
- <method name="getNumContainers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of containers required with the given specifications.
- @return number of containers required with the given specifications]]>
- </doc>
- </method>
- <method name="setNumContainers"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numContainers" type="int"/>
- <doc>
- <![CDATA[Set the number of containers required with the given specifications
- @param numContainers number of containers required with the given
- specifications]]>
- </doc>
- </method>
- <method name="getRelaxLocality" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get whether locality relaxation is enabled with this
- <code>ResourceRequest</code>. Defaults to true.
- @return whether locality relaxation is enabled with this
- <code>ResourceRequest</code>.]]>
- </doc>
- </method>
- <method name="setRelaxLocality"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relaxLocality" type="boolean"/>
- <doc>
- <![CDATA[<p>For a request at a network hierarchy level, set whether locality can be relaxed
- to that level and beyond.<p>
- <p>If the flag is off on a rack-level <code>ResourceRequest</code>,
- containers at that request's priority will not be assigned to nodes on that
- request's rack unless requests specifically for those nodes have also been
- submitted.<p>
- <p>If the flag is off on an {@link ResourceRequest#ANY}-level
- <code>ResourceRequest</code>, containers at that request's priority will
- only be assigned on racks for which specific requests have also been
- submitted.<p>
- <p>For example, to request a container strictly on a specific node, the
- corresponding rack-level and any-level requests should have locality
- relaxation set to false. Similarly, to request a container strictly on a
- specific rack, the corresponding any-level request should have locality
- relaxation set to false.<p>
- @param relaxLocality whether locality relaxation is enabled with this
- <code>ResourceRequest</code>.]]>
- </doc>
- </method>
- <method name="getNodeLabelExpression" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get node-label-expression for this Resource Request. If this is set, all
- containers allocated to satisfy this resource-request will be only on those
- nodes that satisfy this node-label-expression
- @return node-label-expression]]>
- </doc>
- </method>
- <method name="setNodeLabelExpression"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodelabelExpression" type="java.lang.String"/>
- <doc>
- <![CDATA[Set node label expression of this resource request. Now only
- support AND(&&), in the future will provide support for OR(||), NOT(!).
- Examples:
- - GPU && LARGE_MEM, ask for node has label GPU and LARGE_MEM together
- - "" (empty) means ask for node doesn't have label on it, this is default
- behavior
- @param nodelabelExpression node-label-expression of this ResourceRequest]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- </method>
- <field name="ANY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The constant string representing no locality.
- It should be used by all references that want to pass an arbitrary host
- name in.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[<p><code>ResourceRequest</code> represents the request made by an
- application to the <code>ResourceManager</code> to obtain various
- <code>Container</code> allocations.</p>
- <p>It includes:
- <ul>
- <li>{@link Priority} of the request.</li>
- <li>
- The <em>name</em> of the machine or rack on which the allocation is
- desired. A special value of <em>*</em> signifies that
- <em>any</em> host/rack is acceptable to the application.
- </li>
- <li>{@link Resource} required for each request.</li>
- <li>
- Number of containers, of above specifications, which are required
- by the application.
- </li>
- <li>
- A boolean <em>relaxLocality</em> flag, defaulting to <code>true</code>,
- which tells the <code>ResourceManager</code> if the application wants
- locality to be loose (i.e. allows fall-through to rack or <em>any</em>)
- or strict (i.e. specify hard constraint on resource allocation).
- </li>
- </ul>
- </p>
- @see Resource
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
- <class name="ResourceRequest.ResourceRequestComparator" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.util.Comparator"/>
- <implements name="java.io.Serializable"/>
- <constructor name="ResourceRequest.ResourceRequestComparator"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="compare" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r1" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- <param name="r2" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestComparator -->
- <!-- start class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
- <class name="StrictPreemptionContract" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="StrictPreemptionContract"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getContainers" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the set of {@link PreemptionContainer} specifying containers owned by
- the <code>ApplicationMaster</code> that may be reclaimed by the
- <code>ResourceManager</code>.
- @return the set of {@link ContainerId} to be preempted.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Enumeration of particular allocations to be reclaimed. The platform will
- reclaim exactly these resources, so the <code>ApplicationMaster</code> (AM)
- may attempt to checkpoint work or adjust its execution plan to accommodate
- it. In contrast to {@link PreemptionContract}, the AM has no flexibility in
- selecting which resources to return to the cluster.
- @see PreemptionMessage]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.StrictPreemptionContract -->
- <!-- start class org.apache.hadoop.yarn.api.records.Token -->
- <class name="Token" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="Token"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getIdentifier" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token identifier.
- @return token identifier]]>
- </doc>
- </method>
- <method name="getPassword" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token password
- @return token password]]>
- </doc>
- </method>
- <method name="getKind" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the token kind.
- @return token kind]]>
- </doc>
- </method>
- <method name="getService" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the service to which the token is allocated.
- @return service to which the token is allocated]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>Token</code> is the security entity used by the framework
- to verify authenticity of any resource.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.Token -->
- <!-- start class org.apache.hadoop.yarn.api.records.URL -->
- <class name="URL" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="URL"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.URL"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scheme" type="java.lang.String"/>
- <param name="host" type="java.lang.String"/>
- <param name="port" type="int"/>
- <param name="file" type="java.lang.String"/>
- </method>
- <method name="getScheme" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the scheme of the URL.
- @return scheme of the URL]]>
- </doc>
- </method>
- <method name="setScheme"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scheme" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the scheme of the URL
- @param scheme scheme of the URL]]>
- </doc>
- </method>
- <method name="getUserInfo" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user info of the URL.
- @return user info of the URL]]>
- </doc>
- </method>
- <method name="setUserInfo"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="userInfo" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the user info of the URL.
- @param userInfo user info of the URL]]>
- </doc>
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the host of the URL.
- @return host of the URL]]>
- </doc>
- </method>
- <method name="setHost"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="host" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the host of the URL.
- @param host host of the URL]]>
- </doc>
- </method>
- <method name="getPort" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the port of the URL.
- @return port of the URL]]>
- </doc>
- </method>
- <method name="setPort"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="port" type="int"/>
- <doc>
- <![CDATA[Set the port of the URL
- @param port port of the URL]]>
- </doc>
- </method>
- <method name="getFile" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the file of the URL.
- @return file of the URL]]>
- </doc>
- </method>
- <method name="setFile"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="file" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the file of the URL.
- @param file file of the URL]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>URL</code> represents a serializable {@link java.net.URL}.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.URL -->
- <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
- <class name="YarnApplicationAttemptState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration of various states of a <code>RMAppAttempt</code>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState -->
- <!-- start class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
- <class name="YarnApplicationState" extends="java.lang.Enum"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="values" return="org.apache.hadoop.yarn.api.records.YarnApplicationState[]"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="valueOf" return="org.apache.hadoop.yarn.api.records.YarnApplicationState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[Enumeration of various states of an <code>ApplicationMaster</code>.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.YarnApplicationState -->
- <!-- start class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
- <class name="YarnClusterMetrics" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="YarnClusterMetrics"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNumNodeManagers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of <code>NodeManager</code>s in the cluster.
- @return number of <code>NodeManager</code>s in the cluster]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p><code>YarnClusterMetrics</code> represents cluster metrics.</p>
- <p>Currently only number of <code>NodeManager</code>s is provided.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.YarnClusterMetrics -->
- </package>
- <package name="org.apache.hadoop.yarn.api.records.timeline">
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
- <class name="TimelineDelegationTokenResponse" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineDelegationTokenResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="java.lang.String"/>
- </method>
- <method name="getContent" return="java.lang.Object"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setContent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="content" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[The response of delegation token related request]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDelegationTokenResponse -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
- <class name="TimelineDomain" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineDomain"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the domain ID
- @return the domain ID]]>
- </doc>
- </method>
- <method name="setId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the domain ID
- @param id the domain ID]]>
- </doc>
- </method>
- <method name="getDescription" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the domain description
- @return the domain description]]>
- </doc>
- </method>
- <method name="setDescription"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="description" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the domain description
- @param description the domain description]]>
- </doc>
- </method>
- <method name="getOwner" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the domain owner
- @return the domain owner]]>
- </doc>
- </method>
- <method name="setOwner"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="owner" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the domain owner. The user doesn't need to set it, which will
- automatically set to the user who puts the domain.
- @param owner the domain owner]]>
- </doc>
- </method>
- <method name="getReaders" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reader (and/or reader group) list string
- @return the reader (and/or reader group) list string]]>
- </doc>
- </method>
- <method name="setReaders"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="readers" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the reader (and/or reader group) list string
- @param readers the reader (and/or reader group) list string]]>
- </doc>
- </method>
- <method name="getWriters" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the writer (and/or writer group) list string
- @return the writer (and/or writer group) list string]]>
- </doc>
- </method>
- <method name="setWriters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writers" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the writer (and/or writer group) list string
- @param writers the writer (and/or writer group) list string]]>
- </doc>
- </method>
- <method name="getCreatedTime" return="java.lang.Long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the created time of the domain
- @return the created time of the domain]]>
- </doc>
- </method>
- <method name="setCreatedTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="createdTime" type="java.lang.Long"/>
- <doc>
- <![CDATA[Set the created time of the domain
- @param createdTime the created time of the domain]]>
- </doc>
- </method>
- <method name="getModifiedTime" return="java.lang.Long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the modified time of the domain
- @return the modified time of the domain]]>
- </doc>
- </method>
- <method name="setModifiedTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="modifiedTime" type="java.lang.Long"/>
- <doc>
- <![CDATA[Set the modified time of the domain
- @param modifiedTime the modified time of the domain]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- This class contains the information about a timeline domain, which is used
- to a user to host a number of timeline entities, isolating them from others'.
- The user can also define the reader and writer users/groups for the the
- domain, which is used to control the access to its entities.
- </p>
- <p>
- The reader and writer users/groups pattern that the user can supply is the
- same as what <code>AccessControlList</code> takes.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomain -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
- <class name="TimelineDomains" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineDomains"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getDomains" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of domains
- @return a list of domains]]>
- </doc>
- </method>
- <method name="addDomain"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="domain" type="org.apache.hadoop.yarn.api.records.timeline.TimelineDomain"/>
- <doc>
- <![CDATA[Add a single domain into the existing domain list
- @param domain
- a single domain]]>
- </doc>
- </method>
- <method name="addDomains"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="domains" type="java.util.List"/>
- <doc>
- <![CDATA[All a list of domains into the existing domain list
- @param domains
- a list of domains]]>
- </doc>
- </method>
- <method name="setDomains"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="domains" type="java.util.List"/>
- <doc>
- <![CDATA[Set the domain list to the given list of domains
- @param domains
- a list of domains]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The class that hosts a list of timeline domains.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineDomains -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
- <class name="TimelineEntities" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineEntities"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getEntities" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of entities
- @return a list of entities]]>
- </doc>
- </method>
- <method name="addEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
- <doc>
- <![CDATA[Add a single entity into the existing entity list
- @param entity
- a single entity]]>
- </doc>
- </method>
- <method name="addEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entities" type="java.util.List"/>
- <doc>
- <![CDATA[All a list of entities into the existing entity list
- @param entities
- a list of entities]]>
- </doc>
- </method>
- <method name="setEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entities" type="java.util.List"/>
- <doc>
- <![CDATA[Set the entity list to the given list of entities
- @param entities
- a list of entities]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The class that hosts a list of timeline entities.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntities -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
- <class name="TimelineEntity" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getEntityType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity type
- @return the entity type]]>
- </doc>
- </method>
- <method name="setEntityType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity type
- @param entityType
- the entity type]]>
- </doc>
- </method>
- <method name="getEntityId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity Id
- @return the entity Id]]>
- </doc>
- </method>
- <method name="setEntityId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity Id
- @param entityId
- the entity Id]]>
- </doc>
- </method>
- <method name="getStartTime" return="java.lang.Long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the start time of the entity
- @return the start time of the entity]]>
- </doc>
- </method>
- <method name="setStartTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="startTime" type="java.lang.Long"/>
- <doc>
- <![CDATA[Set the start time of the entity
- @param startTime
- the start time of the entity]]>
- </doc>
- </method>
- <method name="getEvents" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of events related to the entity
- @return a list of events related to the entity]]>
- </doc>
- </method>
- <method name="addEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
- <doc>
- <![CDATA[Add a single event related to the entity to the existing event list
- @param event
- a single event related to the entity]]>
- </doc>
- </method>
- <method name="addEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="events" type="java.util.List"/>
- <doc>
- <![CDATA[Add a list of events related to the entity to the existing event list
- @param events
- a list of events related to the entity]]>
- </doc>
- </method>
- <method name="setEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="events" type="java.util.List"/>
- <doc>
- <![CDATA[Set the event list to the given list of events related to the entity
- @param events
- events a list of events related to the entity]]>
- </doc>
- </method>
- <method name="getRelatedEntities" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the related entities
- @return the related entities]]>
- </doc>
- </method>
- <method name="addRelatedEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityType" type="java.lang.String"/>
- <param name="entityId" type="java.lang.String"/>
- <doc>
- <![CDATA[Add an entity to the existing related entity map
- @param entityType
- the entity type
- @param entityId
- the entity Id]]>
- </doc>
- </method>
- <method name="addRelatedEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relatedEntities" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a map of related entities to the existing related entity map
- @param relatedEntities
- a map of related entities]]>
- </doc>
- </method>
- <method name="setRelatedEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relatedEntities" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the related entity map to the given map of related entities
- @param relatedEntities
- a map of related entities]]>
- </doc>
- </method>
- <method name="getPrimaryFilters" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the primary filters
- @return the primary filters]]>
- </doc>
- </method>
- <method name="addPrimaryFilter"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Add a single piece of primary filter to the existing primary filter map
- @param key
- the primary filter key
- @param value
- the primary filter value]]>
- </doc>
- </method>
- <method name="addPrimaryFilters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="primaryFilters" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a map of primary filters to the existing primary filter map
- @param primaryFilters
- a map of primary filters]]>
- </doc>
- </method>
- <method name="setPrimaryFilters"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="primaryFilters" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the primary filter map to the given map of primary filters
- @param primaryFilters
- a map of primary filters]]>
- </doc>
- </method>
- <method name="getOtherInfo" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the other information of the entity
- @return the other information of the entity]]>
- </doc>
- </method>
- <method name="addOtherInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Add one piece of other information of the entity to the existing other info
- map
- @param key
- the other information key
- @param value
- the other information value]]>
- </doc>
- </method>
- <method name="addOtherInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="otherInfo" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a map of other information of the entity to the existing other info map
- @param otherInfo
- a map of other information]]>
- </doc>
- </method>
- <method name="setOtherInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="otherInfo" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the other info map to the given map of other information
- @param otherInfo
- a map of other information]]>
- </doc>
- </method>
- <method name="getDomainId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the ID of the domain that the entity is to be put
- @return the domain ID]]>
- </doc>
- </method>
- <method name="setDomainId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="domainId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the ID of the domain that the entity is to be put
- @param domainId
- the name space ID]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="obj" type="java.lang.Object"/>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEntity"/>
- </method>
- <doc>
- <![CDATA[<p>
- The class that contains the the meta information of some conceptual entity
- and its related events. The entity can be an application, an application
- attempt, a container or whatever the user-defined object.
- </p>
- <p>
- Primary filters will be used to index the entities in
- <code>TimelineStore</code>, such that users should carefully choose the
- information they want to store as the primary filters. The remaining can be
- stored as other information.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
- <class name="TimelineEvent" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="TimelineEvent"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getTimestamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the timestamp of the event
- @return the timestamp of the event]]>
- </doc>
- </method>
- <method name="setTimestamp"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timestamp" type="long"/>
- <doc>
- <![CDATA[Set the timestamp of the event
- @param timestamp
- the timestamp of the event]]>
- </doc>
- </method>
- <method name="getEventType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the event type
- @return the event type]]>
- </doc>
- </method>
- <method name="setEventType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the event type
- @param eventType
- the event type]]>
- </doc>
- </method>
- <method name="getEventInfo" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set the information of the event
- @return the information of the event]]>
- </doc>
- </method>
- <method name="addEventInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <param name="value" type="java.lang.Object"/>
- <doc>
- <![CDATA[Add one piece of the information of the event to the existing information
- map
- @param key
- the information key
- @param value
- the information value]]>
- </doc>
- </method>
- <method name="addEventInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventInfo" type="java.util.Map"/>
- <doc>
- <![CDATA[Add a map of the information of the event to the existing information map
- @param eventInfo
- a map of of the information of the event]]>
- </doc>
- </method>
- <method name="setEventInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventInfo" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the information map to the given map of the information of the event
- @param eventInfo
- a map of of the information of the event]]>
- </doc>
- </method>
- <method name="compareTo" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="other" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
- </method>
- <method name="equals" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="o" type="java.lang.Object"/>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[The class that contains the information of an event that is related to some
- conceptual entity of an application. Users are free to define what the event
- means, such as starting an application, getting allocated a container and
- etc.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvent -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
- <class name="TimelineEvents" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineEvents"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAllEvents" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of {@link EventsOfOneEntity} instances
- @return a list of {@link EventsOfOneEntity} instances]]>
- </doc>
- </method>
- <method name="addEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventsOfOneEntity" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity"/>
- <doc>
- <![CDATA[Add a single {@link EventsOfOneEntity} instance into the existing list
- @param eventsOfOneEntity
- a single {@link EventsOfOneEntity} instance]]>
- </doc>
- </method>
- <method name="addEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allEvents" type="java.util.List"/>
- <doc>
- <![CDATA[Add a list of {@link EventsOfOneEntity} instances into the existing list
- @param allEvents
- a list of {@link EventsOfOneEntity} instances]]>
- </doc>
- </method>
- <method name="setEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allEvents" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list to the given list of {@link EventsOfOneEntity} instances
- @param allEvents
- a list of {@link EventsOfOneEntity} instances]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The class that hosts a list of events, which are categorized according to
- their related entities.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
- <class name="TimelineEvents.EventsOfOneEntity" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineEvents.EventsOfOneEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getEntityId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity Id
- @return the entity Id]]>
- </doc>
- </method>
- <method name="setEntityId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity Id
- @param entityId
- the entity Id]]>
- </doc>
- </method>
- <method name="getEntityType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity type
- @return the entity type]]>
- </doc>
- </method>
- <method name="setEntityType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity type
- @param entityType
- the entity type]]>
- </doc>
- </method>
- <method name="getEvents" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of events
- @return a list of events]]>
- </doc>
- </method>
- <method name="addEvent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="event" type="org.apache.hadoop.yarn.api.records.timeline.TimelineEvent"/>
- <doc>
- <![CDATA[Add a single event to the existing event list
- @param event
- a single event]]>
- </doc>
- </method>
- <method name="addEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="events" type="java.util.List"/>
- <doc>
- <![CDATA[Add a list of event to the existing event list
- @param events
- a list of events]]>
- </doc>
- </method>
- <method name="setEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="events" type="java.util.List"/>
- <doc>
- <![CDATA[Set the event list to the given list of events
- @param events
- a list of events]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The class that hosts a list of events that are only related to one entity.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEvents.EventsOfOneEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
- <class name="TimelinePutResponse" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelinePutResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getErrors" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get a list of {@link TimelinePutError} instances
- @return a list of {@link TimelinePutError} instances]]>
- </doc>
- </method>
- <method name="addError"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="error" type="org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError"/>
- <doc>
- <![CDATA[Add a single {@link TimelinePutError} instance into the existing list
- @param error
- a single {@link TimelinePutError} instance]]>
- </doc>
- </method>
- <method name="addErrors"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="errors" type="java.util.List"/>
- <doc>
- <![CDATA[Add a list of {@link TimelinePutError} instances into the existing list
- @param errors
- a list of {@link TimelinePutError} instances]]>
- </doc>
- </method>
- <method name="setErrors"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="errors" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list to the given list of {@link TimelinePutError} instances
- @param errors
- a list of {@link TimelinePutError} instances]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A class that holds a list of put errors. This is the response returned when a
- list of {@link TimelineEntity} objects is added to the timeline. If there are errors
- in storing individual entity objects, they will be indicated in the list of
- errors.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse -->
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
- <class name="TimelinePutResponse.TimelinePutError" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelinePutResponse.TimelinePutError"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getEntityId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity Id
- @return the entity Id]]>
- </doc>
- </method>
- <method name="setEntityId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity Id
- @param entityId
- the entity Id]]>
- </doc>
- </method>
- <method name="getEntityType" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the entity type
- @return the entity type]]>
- </doc>
- </method>
- <method name="setEntityType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityType" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity type
- @param entityType
- the entity type]]>
- </doc>
- </method>
- <method name="getErrorCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the error code
- @return an error code]]>
- </doc>
- </method>
- <method name="setErrorCode"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="errorCode" type="int"/>
- <doc>
- <![CDATA[Set the error code to the given error code
- @param errorCode
- an error code]]>
- </doc>
- </method>
- <field name="NO_START_TIME" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned when no start time can be found when putting an
- entity. This occurs when the entity does not already exist in the store
- and it is put with no start time or events specified.]]>
- </doc>
- </field>
- <field name="IO_EXCEPTION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if an IOException is encountered when putting an
- entity.]]>
- </doc>
- </field>
- <field name="SYSTEM_FILTER_CONFLICT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if the user specifies the timeline system reserved
- filter key]]>
- </doc>
- </field>
- <field name="ACCESS_DENIED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if the user is denied to access the timeline data]]>
- </doc>
- </field>
- <field name="NO_DOMAIN" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if the entity doesn't have an valid domain ID]]>
- </doc>
- </field>
- <field name="FORBIDDEN_RELATION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if the user is denied to relate the entity to another
- one in different domain]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A class that holds the error code for one entity.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelinePutResponse.TimelinePutError -->
- </package>
- <package name="org.apache.hadoop.yarn.conf">
- <!-- start class org.apache.hadoop.yarn.conf.YarnConfiguration -->
- <class name="YarnConfiguration" extends="org.apache.hadoop.conf.Configuration"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="YarnConfiguration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YarnConfiguration" type="org.apache.hadoop.conf.Configuration"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSocketAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="defaultAddress" type="java.lang.String"/>
- <param name="defaultPort" type="int"/>
- <doc>
- <![CDATA[Get the socket address for <code>name</code> property as a
- <code>InetSocketAddress</code>. On an HA cluster,
- this fetches the address corresponding to the RM identified by
- {@link #RM_HA_ID}.
- @param name property name.
- @param defaultAddress the default value
- @param defaultPort the default port
- @return InetSocketAddress]]>
- </doc>
- </method>
- <method name="updateConnectAddr" return="java.net.InetSocketAddress"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="addr" type="java.net.InetSocketAddress"/>
- </method>
- <method name="useHttps" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- </method>
- <field name="CS_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_POLICY_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SITE_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CORE_SITE_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CONFIGURATION_FILES" type="java.util.List"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_MAX_TAGS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_MAX_TAG_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEBUG_NM_DELETE_DELAY_SEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Delay before deleting resource to ease debugging of NM issues]]>
- </doc>
- </field>
- <field name="IPC_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Factory to create client IPC classes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IPC_CLIENT_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Factory to create server IPC classes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IPC_SERVER_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Factory to create serializeable records.]]>
- </doc>
- </field>
- <field name="DEFAULT_IPC_RECORD_FACTORY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IPC_RPC_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[RPC class implementation]]>
- </doc>
- </field>
- <field name="DEFAULT_IPC_RPC_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CLUSTER_ID" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_HOSTNAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the applications manager interface in the RM.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The actual bind address for the RM.]]>
- </doc>
- </field>
- <field name="RM_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of threads used to handle applications manager requests.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PRINCIPAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Kerberos principal for the resource manager.]]>
- </doc>
- </field>
- <field name="RM_SCHEDULER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the scheduler interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SCHEDULER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Miniumum request grant-able by the RM scheduler.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_MB" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SCHEDULER_MINIMUM_ALLOCATION_VCORES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Maximum request grant-able by the RM scheduler.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_MB" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SCHEDULER_MAXIMUM_ALLOCATION_VCORES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads to handle scheduler interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_INCLUDE_PORT_IN_NODE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If the port should be included or not in the node name. The node name
- is used by the scheduler for resource requests allocation location
- matching. Typically this is just the hostname, using the port is needed
- when using minicluster and specific NM are required.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_USE_PORT_FOR_NODE_NAME" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_RESERVATION_SYSTEM_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the RM should enable Reservation System]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_RESERVATION_SYSTEM_ENABLE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_RESERVATION_SYSTEM_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The class to use as the Reservation System.]]>
- </doc>
- </field>
- <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The PlanFollower for the Reservation System.]]>
- </doc>
- </field>
- <field name="RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The step size of the Reservation System.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_RESERVATION_SYSTEM_PLAN_FOLLOWER_TIME_STEP" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_ENABLE_MONITORS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable periodic monitor threads.
- @see #RM_SCHEDULER_MONITOR_POLICIES]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER_ENABLE_MONITORS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MONITOR_POLICIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[List of SchedulingEditPolicy classes affecting the scheduler.]]>
- </doc>
- </field>
- <field name="RM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the RM web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_WEBAPP_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The https address of the RM web application.]]>
- </doc>
- </field>
- <field name="YARN_SSL_CLIENT_HTTPS_NEED_AUTH_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SSL_SERVER_RESOURCE_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WEBAPP_HTTPS_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_RESOURCE_TRACKER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_RESOURCE_TRACKER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_AM_EXPIRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The expiry interval for application master reporting.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_AM_EXPIRY_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NM_EXPIRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long to wait until a node manager is considered dead.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NM_EXPIRY_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_ACL_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Are acls enabled.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_ACL_ENABLE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_ADMIN_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ACL of who can be admin of YARN cluster.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_ADMIN_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_YARN_APP_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ACL used in case none is found. Allows nothing.]]>
- </doc>
- </field>
- <field name="RM_ADMIN_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the RM admin interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_ADMIN_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ADMIN_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ADMIN_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads used to handle RM admin interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_ADMIN_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_AM_MAX_ATTEMPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum number of application attempts.
- It's a global setting for all application masters.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_AM_MAX_ATTEMPTS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_KEYTAB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The keytab for the resource manager.]]>
- </doc>
- </field>
- <field name="RM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos principal to be used for spnego filter for RM.]]>
- </doc>
- </field>
- <field name="RM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos keytab to be used for spnego filter for RM.]]>
- </doc>
- </field>
- <field name="RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flag to enable override of the default kerberos authentication filter with
- the RM authentication filter to allow authentication using delegation
- tokens(fallback to kerberos if the tokens are missing). Only applicable
- when the http authentication type is kerberos.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_WEBAPP_DELEGATION_TOKEN_AUTH_FILTER" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long to wait until a container is considered dead.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_CONTAINER_ALLOC_EXPIRY_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Path to file with nodes to include.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NODES_INCLUDE_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Path to file with nodes to exclude.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NODES_EXCLUDE_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads to handle resource tracker calls.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_RESOURCE_TRACKER_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The class to use as the resource scheduler.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDULER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NM_HEARTBEAT_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[RM set next Heartbeat interval for NM]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of worker threads that write the history data.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_HISTORY_WRITER_MULTI_THREADED_DISPATCHER_POOL_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting that controls whether yarn system metrics is published on the
- timeline server or not by RM.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SYSTEM_METRICS_PUBLISHER_DISPATCHER_POOL_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_KEY_UPDATE_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_RENEW_INTERVAL_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_MAX_LIFETIME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RECOVERY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_RECOVERY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_WORK_PRESERVING_RECOVERY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_WORK_PRESERVING_RECOVERY_SCHEDULING_WAIT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Zookeeper interaction configs]]>
- </doc>
- </field>
- <field name="RM_ZK_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_NUM_RETRIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ZK_RM_NUM_RETRIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_RETRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ZK_RETRY_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_TIMEOUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ZK_TIMEOUT_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_ZK_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ZK_AUTH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ZK_STATE_STORE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Parent znode path under which ZKRMStateStore will create znodes]]>
- </doc>
- </field>
- <field name="DEFAULT_ZK_RM_STATE_STORE_PARENT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ZK_RM_STATE_STORE_ROOT_NODE_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Root node ACLs for fencing]]>
- </doc>
- </field>
- <field name="RM_HA_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[HA related configs]]>
- </doc>
- </field>
- <field name="RM_HA_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_HA_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_HA_IDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_HA_ID" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_BASED_RM_CONF_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Store the related configuration files in File System]]>
- </doc>
- </field>
- <field name="DEFAULT_FS_BASED_RM_CONF_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_CONFIGURATION_PROVIDER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AUTO_FAILOVER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AUTO_FAILOVER_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AUTO_FAILOVER_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AUTO_FAILOVER_EMBEDDED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AUTO_FAILOVER_ZK_BASE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CLIENT_FAILOVER_PROXY_PROVIDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_MAX_ATTEMPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_SLEEPTIME_BASE_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_SLEEPTIME_MAX_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_RETRIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CLIENT_FAILOVER_RETRIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CLIENT_FAILOVER_RETRIES_ON_SOCKET_TIMEOUTS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The class to use as the persistent store.]]>
- </doc>
- </field>
- <field name="FS_RM_STATE_STORE_URI" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[URI for FileSystemRMStateStore]]>
- </doc>
- </field>
- <field name="FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FS_RM_STATE_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum number of completed applications RM keeps.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_MAX_COMPLETED_APPLICATIONS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum number of completed applications RM state store keeps, by
- default equals to DEFAULT_RM_MAX_COMPLETED_APPLICATIONS]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_STATE_STORE_MAX_COMPLETED_APPLICATIONS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_APPLICATION_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default application name]]>
- </doc>
- </field>
- <field name="DEFAULT_APPLICATION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default application type]]>
- </doc>
- </field>
- <field name="APPLICATION_TYPE_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default application type length]]>
- </doc>
- </field>
- <field name="DEFAULT_QUEUE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default queue name]]>
- </doc>
- </field>
- <field name="RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Buckets (in minutes) for the number of apps running in each queue.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_METRICS_RUNTIME_BUCKETS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default sizes of the runtime metric buckets in minutes.]]>
- </doc>
- </field>
- <field name="RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_AMRM_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_CONTAINER_TOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_NMTOKEN_MASTER_KEY_ROLLING_INTERVAL_SECS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_NODEMANAGER_MINIMUM_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PROXY_USER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[RM proxy users' prefix]]>
- </doc>
- </field>
- <field name="NM_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prefix for all node manager configs.]]>
- </doc>
- </field>
- <field name="NM_ADMIN_USER_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Environment variables that will be sent to containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_ADMIN_USER_ENV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_ENV_WHITELIST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Environment variables that containers may override rather than use NodeManager's default.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_ENV_WHITELIST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[address of node manager IPC.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The actual bind address or the NM.]]>
- </doc>
- </field>
- <field name="NM_CONTAINER_EXECUTOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[who will execute(launch) the containers.]]>
- </doc>
- </field>
- <field name="NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Adjustment to make to the container os scheduling priority.
- The valid values for this could vary depending on the platform.
- On Linux, higher values mean run the containers at a less
- favorable priority than the NM.
- The value specified is an int.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_EXECUTOR_SCHED_PRIORITY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_MGR_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads container manager uses.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_MGR_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_DELETE_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads used in cleanup.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DELETE_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_KEYTAB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Keytab for NM.]]>
- </doc>
- </field>
- <field name="NM_LOCAL_DIRS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[List of directories to store localized files in.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCAL_DIRS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of files in each localized directories
- Avoid tuning this too low.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCAL_CACHE_MAX_FILES_PER_DIRECTORY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Address where the localizer IPC is.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_LOCALIZER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Interval in between cache cleanups.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_CACHE_CLEANUP_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Target size of localizer cache in MB, per nodemanager. It is a target
- retention size that only includes resources with PUBLIC and PRIVATE
- visibility and excludes resources with APPLICATION visibility]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_CACHE_TARGET_SIZE_MB" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads to handle localization requests.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOCALIZER_FETCH_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads to use for localization fetching.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOCALIZER_FETCH_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_DIRS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Where to store container logs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_DIRS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_RESOURCEMANAGER_MINIMUM_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Interval at which the delayed token removal thread runs]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_DELAYED_DELEGATION_TOKEN_REMOVAL_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Delegation Token renewer thread count]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_DELEGATION_TOKEN_RENEWER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PROXY_USER_PRIVILEGES_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_PROXY_USER_PRIVILEGES_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG_AGGREGATION_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether to enable log aggregation]]>
- </doc>
- </field>
- <field name="DEFAULT_LOG_AGGREGATION_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG_AGGREGATION_RETAIN_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long to wait before deleting aggregated logs, -1 disables.
- Be careful set this too small and you will spam the name node.]]>
- </doc>
- </field>
- <field name="DEFAULT_LOG_AGGREGATION_RETAIN_SECONDS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long to wait between aggregated log retention checks. If set to
- a value <= 0 then the value is computed as one-tenth of the log retention
- setting. Be careful set this too small and you will spam the name node.]]>
- </doc>
- </field>
- <field name="DEFAULT_LOG_AGGREGATION_RETAIN_CHECK_INTERVAL_SECONDS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_RETAIN_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of seconds to retain logs on the NodeManager. Only applicable if Log
- aggregation is disabled]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_RETAIN_SECONDS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Define how often NMs wake up and upload log files]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_DELETION_THREADS_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of threads used in log cleanup. Only applicable if Log aggregation
- is disabled]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_DELETE_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Where to aggregate logs to.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The remote log dir will be created at
- NM_REMOTE_APP_LOG_DIR/${user}/NM_REMOTE_APP_LOG_DIR_SUFFIX/${appId}]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_SUFFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_LOG_SERVER_URL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_TRACKING_URL_GENERATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PMEM_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Amount of memory in GB that can be allocated for containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PMEM_MB" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PMEM_CHECK_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies whether physical memory check is enabled.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PMEM_CHECK_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_VMEM_CHECK_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies whether physical memory check is enabled.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_VMEM_CHECK_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_VMEM_PMEM_RATIO" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Conversion ratio for physical memory to virtual memory.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_VMEM_PMEM_RATIO" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_VCORES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of Virtual CPU Cores which can be allocated for containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_VCORES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Percentage of overall CPU which can be allocated for containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RESOURCE_PERCENTAGE_PHYSICAL_CPU_LIMIT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[NM Webapp address.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_WEBAPP_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[NM Webapp https address.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_WEBAPP_HTTPS_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_MON_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How often to monitor containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_MON_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_MON_RESOURCE_CALCULATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Class that calculates containers current resource utilization.]]>
- </doc>
- </field>
- <field name="NM_CONTAINER_MON_PROCESS_TREE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Class that calculates process tree resource utilization.]]>
- </doc>
- </field>
- <field name="PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_PROCFS_USE_SMAPS_BASED_RSS_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_DISK_HEALTH_CHECK_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/Disable disks' health checker. Default is true. An expert level
- configuration property.]]>
- </doc>
- </field>
- <field name="NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Frequency of running disks' health checker.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DISK_HEALTH_CHECK_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[By default, disks' health is checked every 2 minutes.]]>
- </doc>
- </field>
- <field name="NM_MIN_HEALTHY_DISKS_FRACTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The minimum fraction of number of disks to be healthy for the nodemanager
- to launch new containers. This applies to nm-local-dirs and nm-log-dirs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_MIN_HEALTHY_DISKS_FRACTION" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[By default, at least 25% of disks are to be healthy to say that the node is
- healthy in terms of disks.]]>
- </doc>
- </field>
- <field name="NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum percentage of disk space that can be used after which a disk is
- marked as offline. Values can range from 0.0 to 100.0. If the value is
- greater than or equal to 100, NM will check for full disk. This applies to
- nm-local-dirs and nm-log-dirs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[By default, 90% of the disk can be used before it is marked as offline.]]>
- </doc>
- </field>
- <field name="NM_MIN_PER_DISK_FREE_SPACE_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The minimum space that must be available on a local dir for it to be used.
- This applies to nm-local-dirs and nm-log-dirs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_MIN_PER_DISK_FREE_SPACE_MB" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[By default, all of the disk can be used before it is marked as offline.]]>
- </doc>
- </field>
- <field name="NM_HEALTH_CHECK_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Frequency of running node health script.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_HEALTH_CHECK_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Health check script time out period.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPT_TIMEOUT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_HEALTH_CHECK_SCRIPT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The health check script to run.]]>
- </doc>
- </field>
- <field name="NM_HEALTH_CHECK_SCRIPT_OPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The arguments to pass to the health check script.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_CONTAINER_EXECUTOR_IMAGE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Docker image name(For DockerContainerExecutor).]]>
- </doc>
- </field>
- <field name="NM_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name of the docker executor (For DockerContainerExecutor).]]>
- </doc>
- </field>
- <field name="NM_DEFAULT_DOCKER_CONTAINER_EXECUTOR_EXEC_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default docker executor (For DockerContainerExecutor).]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_EXECUTOR_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The path to the Linux container executor.]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_GROUP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The UNIX group that the linux-container-executor should run as.
- This is intended to be set as part of container-executor.cfg.]]>
- </doc>
- </field>
- <field name="NM_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[If linux-container-executor should limit itself to one user
- when running in non-secure mode.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NONSECURE_MODE_LIMIT_USERS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NONSECURE_MODE_LOCAL_USER_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The UNIX user that containers will run as when Linux-container-executor
- is used in nonsecure mode (a use case for this is using cgroups).]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NONSECURE_MODE_LOCAL_USER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NONSECURE_MODE_USER_PATTERN_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The allowed pattern for UNIX user names enforced by
- Linux-container-executor when used in nonsecure mode (use case for this
- is using cgroups). The default value is taken from /usr/sbin/adduser]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NONSECURE_MODE_USER_PATTERN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LINUX_CONTAINER_RESOURCES_HANDLER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The type of resource enforcement to use with the
- linux container executor.]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_HIERARCHY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The path the linux container executor should use for cgroups]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the linux container executor should mount cgroups if not found]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_MOUNT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Where the linux container executor should mount cgroups if not found]]>
- </doc>
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the apps should run in strict resource usage mode(not allowed to
- use spare CPU)]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_STRICT_RESOURCE_USAGE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Interval of time the linux container executor should try cleaning up
- cgroups entry when cleaning up a container. This is required due to what
- it seems a race condition because the SIGTERM/SIGKILL is asynch.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_TIMEOUT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WINDOWS_SECURE_CONTAINER_GROUP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[/* The Windows group that the windows-secure-container-executor should run as.]]>
- </doc>
- </field>
- <field name="NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[T-file compression types used to compress aggregated logs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_AGG_COMPRESSION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PRINCIPAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos principal for the node manager.]]>
- </doc>
- </field>
- <field name="NM_AUX_SERVICES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_AUX_SERVICE_FMT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_USER_HOME_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WEBAPP_SPNEGO_USER_NAME_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos principal to be used for spnego filter for NM.]]>
- </doc>
- </field>
- <field name="NM_WEBAPP_SPNEGO_KEYTAB_FILE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos keytab to be used for spnego filter for NM.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_USER_HOME_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RECOVERY_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RECOVERY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_RECOVERY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RECOVERY_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PROXY_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PROXY_PRINCIPAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The kerberos principal for the proxy.]]>
- </doc>
- </field>
- <field name="PROXY_KEYTAB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Keytab for Proxy.]]>
- </doc>
- </field>
- <field name="PROXY_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address for the web proxy.]]>
- </doc>
- </field>
- <field name="DEFAULT_PROXY_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_PROXY_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCETRACKER_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[YARN Service Level Authorization]]>
- </doc>
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONCLIENT_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCEMANAGER_ADMINISTRATION_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONMASTER_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_CONTAINER_MANAGEMENT_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_RESOURCE_LOCALIZER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_SECURITY_SERVICE_AUTHORIZATION_APPLICATIONHISTORY_PROTOCOL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[No. of milliseconds to wait between sending a SIGTERM and SIGKILL
- to a running container]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_SLEEP_DELAY_BEFORE_SIGKILL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PROCESS_KILL_WAIT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max time to wait for a process to come up when trying to cleanup
- container resources]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PROCESS_KILL_WAIT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max time to wait to establish a connection to RM]]>
- </doc>
- </field>
- <field name="DEFAULT_RESOURCEMANAGER_CONNECT_MAX_WAIT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Time interval between each attempt to connect to RM]]>
- </doc>
- </field>
- <field name="DEFAULT_RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_APPLICATION_CLASSPATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[CLASSPATH for YARN applications. A comma-separated list of CLASSPATH
- entries]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default platform-agnostic CLASSPATH for YARN applications. A
- comma-separated list of CLASSPATH entries. The parameter expansion marker
- will be replaced with real parameter expansion marker ('%' for Windows and
- '$' for Linux) by NodeManager on container launch. For example: {{VAR}}
- will be replaced as $VAR on Linux, and %VAR% on Windows.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_APPLICATION_CLASSPATH" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- Default platform-specific CLASSPATH for YARN applications. A
- comma-separated list of CLASSPATH entries constructed based on the client
- OS environment expansion syntax.
- </p>
- <p>
- Note: Use {@link DEFAULT_YARN_CROSS_PLATFORM_APPLICATION_CLASSPATH} for
- cross-platform practice i.e. submit an application from a Windows client to
- a Linux/Unix server or vice versa.
- </p>]]>
- </doc>
- </field>
- <field name="DEFAULT_CONTAINER_TEMP_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container temp directory]]>
- </doc>
- </field>
- <field name="IS_MINI_YARN_CLUSTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_MC_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_MINICLUSTER_FIXED_PORTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether to use fixed ports with the minicluster.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_MINICLUSTER_FIXED_PORTS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default is false to be able to run tests concurrently without port
- conflicts.]]>
- </doc>
- </field>
- <field name="YARN_MINICLUSTER_USE_RPC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether the NM should use RPC to connect to the RM. Default is false.
- Can be set to true only when using fixed ports.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_MINICLUSTER_USE_RPC" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether users are explicitly trying to control resource monitoring
- configuration for the MiniYARNCluster. Disabled by default.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_MINICLUSTER_CONTROL_RESOURCE_MONITORING" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_APP_CONTAINER_LOG_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The log directory for the containers]]>
- </doc>
- </field>
- <field name="YARN_APP_CONTAINER_LOG_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_APP_CONTAINER_LOG_BACKUPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_HISTORY_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_HISTORY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting that controls whether application history service is
- enabled or not.]]>
- </doc>
- </field>
- <field name="DEFAULT_APPLICATION_HISTORY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_HISTORY_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Application history store class]]>
- </doc>
- </field>
- <field name="FS_APPLICATION_HISTORY_STORE_URI" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[URI for FileSystemApplicationHistoryStore]]>
- </doc>
- </field>
- <field name="FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[T-file compression types used to compress history data.]]>
- </doc>
- </field>
- <field name="DEFAULT_FS_APPLICATION_HISTORY_STORE_COMPRESSION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting that controls whether timeline service is enabled or not.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[host:port address for timeline service RPC APIs.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The listening endpoint for the timeline service application.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_HANDLER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of threads to handle client RPC API requests.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the timeline service web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The https address of the timeline service web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service store class]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_TTL_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service enable data age off]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_TTL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service length of time to retain data]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_TTL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb path]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb read cache (uncompressed blocks)]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_READ_CACHE_SIZE" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb start time read cache (number of entities)]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_READ_CACHE_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb start time write cache (number of entities)]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_START_TIME_WRITE_CACHE_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb interval to wait between deletion rounds]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_TTL_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_PRINCIPAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Kerberos principal for the timeline server.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_KEYTAB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The Kerberos keytab for the timeline server.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enables cross origin support for timeline server.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_HTTP_CROSS_ORIGIN_ENABLED_DEFAULT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default value for cross origin support for timeline server.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline client settings]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline client call, max retries (-1 means no limit)]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_MAX_RETRIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline client call, retry interval]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_RETRY_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_CLIENT_APP_SUBMISSION_POLL_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Use YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS instead.
- The interval of the yarn client's querying application state after
- application submission. The unit is millisecond.]]>
- </doc>
- </field>
- <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The interval that the yarn client library uses to poll the completion
- status of the asynchronous API of application client protocol.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The duration that the yarn client library waits, cumulatively across polls,
- for an expected state change to occur. Defaults to -1, which indicates no
- limit.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_CLIENT_APPLICATION_CLIENT_PROTOCOL_POLL_TIMEOUT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max number of threads in NMClientAsync to process container management
- events]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CLIENT_MAX_NM_PROXIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Maximum number of proxy connections to cache for node managers. If set
- to a value greater than zero then the cache is enabled and the NMClient
- and MRAppMaster will cache the specified number of node manager proxies.
- There will be at max one proxy per node manager. Ex. configuring it to a
- value of 5 will make sure that client will at max have 5 proxies cached
- with 5 different node managers. These connections for these proxies will
- be timed out if idle for more than the system wide idle timeout period.
- Note that this could cause issues on large clusters as many connections
- could linger simultaneously and lead to a large number of connection
- threads. The token used for authentication will be used only at
- connection creation time. If a new token is received then the earlier
- connection should be closed in order to use the new token. This and
- {@link YarnConfiguration#NM_CLIENT_ASYNC_THREAD_POOL_MAX_SIZE} are related
- and should be in sync (no need for them to be equal).
- If the value of this property is zero then the connection cache is
- disabled and connections will use a zero idle timeout to prevent too
- many connection threads on large clusters.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CLIENT_MAX_NM_PROXIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_NM_CONNECT_MAX_WAIT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max time to wait to establish a connection to NM]]>
- </doc>
- </field>
- <field name="DEFAULT_CLIENT_NM_CONNECT_MAX_WAIT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Time interval between each attempt to connect to NM]]>
- </doc>
- </field>
- <field name="DEFAULT_CLIENT_NM_CONNECT_RETRY_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_HTTP_POLICY_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_HTTP_POLICY_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NODE_LABELS_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODE_LABELS_MANAGER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Class for RMNodeLabelsManager Please note this value should be consistent
- in client nodes and RM node(s)]]>
- </doc>
- </field>
- <field name="FS_NODE_LABELS_STORE_ROOT_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[URI for NodeLabelManager]]>
- </doc>
- </field>
- <field name="FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FS_NODE_LABELS_STORE_RETRY_POLICY_SPEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- </class>
- <!-- end class org.apache.hadoop.yarn.conf.YarnConfiguration -->
- </package>
- <package name="org.apache.hadoop.yarn.exceptions">
- <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
- <class name="ApplicationAttemptNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationAttemptNotFoundException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationAttemptNotFoundException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown on
- {@link ApplicationHistoryProtocol#getApplicationAttemptReport (GetApplicationAttemptReportRequest)}
- API when the Application Attempt doesn't exist in Application History Server or
- {@link ApplicationMasterProtocol#allocate(AllocateRequest)} if application
- doesn't exist in RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationAttemptNotFoundException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
- <class name="ApplicationIdNotProvidedException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationIdNotProvidedException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationIdNotProvidedException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationIdNotProvidedException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Exception to be thrown when Client submit an application without
- providing {@link ApplicationId} in {@link ApplicationSubmissionContext}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationIdNotProvidedException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationMasterNotRegisteredException -->
- <class name="ApplicationMasterNotRegisteredException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationMasterNotRegisteredException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when an Application Master tries to unregister by calling
- {@link ApplicationMasterProtocol#finishApplicationMaster(FinishApplicationMasterRequest)}
- API without first registering by calling
- {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
- or after an RM restart. The ApplicationMaster is expected to call
- {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
- and retry.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationMasterNotRegisteredException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
- <class name="ApplicationNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationNotFoundException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationNotFoundException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationNotFoundException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown on
- {@link ApplicationClientProtocol#getApplicationReport
- (GetApplicationReportRequest)} API
- when the Application doesn't exist in RM and AHS]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ApplicationNotFoundException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
- <class name="ContainerNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerNotFoundException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerNotFoundException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerNotFoundException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown on
- {@link ApplicationHistoryProtocol#getContainerReport (GetContainerReportRequest)}
- API when the container doesn't exist in AHS]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ContainerNotFoundException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidApplicationMasterRequestException -->
- <class name="InvalidApplicationMasterRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidApplicationMasterRequestException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidApplicationMasterRequestException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidApplicationMasterRequestException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when an ApplicationMaster asks for resources by
- calling {@link ApplicationMasterProtocol#allocate(AllocateRequest)}
- without first registering by calling
- {@link ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)}
- or if it tries to register more than once.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidApplicationMasterRequestException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidAuxServiceException -->
- <class name="InvalidAuxServiceException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidAuxServiceException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown by a NodeManager that is rejecting start-container
- requests via
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
- for auxservices does not exist.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidAuxServiceException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidContainerException -->
- <class name="InvalidContainerException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidContainerException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown by a NodeManager that is rejecting start-container
- requests via
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
- for containers allocated by a previous instance of the RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidContainerException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidContainerReleaseException -->
- <class name="InvalidContainerReleaseException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidContainerReleaseException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidContainerReleaseException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidContainerReleaseException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when an Application Master tries to release
- containers not belonging to it using
- {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidContainerReleaseException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidResourceBlacklistRequestException -->
- <class name="InvalidResourceBlacklistRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidResourceBlacklistRequestException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when an application provides an invalid
- {@link ResourceBlacklistRequest} specification for blacklisting of resources
- in {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API.
- Currently this exceptions is thrown when an application tries to
- blacklist {@link ResourceRequest#ANY}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidResourceBlacklistRequestException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException -->
- <class name="InvalidResourceRequestException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="InvalidResourceRequestException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidResourceRequestException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="InvalidResourceRequestException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when a resource requested via
- {@link ResourceRequest} in the
- {@link ApplicationMasterProtocol#allocate(AllocateRequest)} API is out of the
- range of the configured lower and upper limits on resources.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.InvalidResourceRequestException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.NMNotYetReadyException -->
- <class name="NMNotYetReadyException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NMNotYetReadyException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown on
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)} API
- when an NM starts from scratch but has not yet connected with RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.NMNotYetReadyException -->
- <!-- start class org.apache.hadoop.yarn.exceptions.YarnException -->
- <class name="YarnException" extends="java.lang.Exception"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="YarnException"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YarnException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YarnException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YarnException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[YarnException indicates exceptions from yarn servers. On the other hand,
- IOExceptions indicates exceptions from RPC layer.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.YarnException -->
- </package>
- <package name="org.apache.hadoop.yarn.server.api">
- <!-- start class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
- <class name="ApplicationInitializationContext" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ApplicationId, java.nio.ByteBuffer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the user-name of the application-submitter
- @return user-name]]>
- </doc>
- </method>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link ApplicationId} of the application
- @return applications ID]]>
- </doc>
- </method>
- <method name="getApplicationDataForService" return="java.nio.ByteBuffer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the data sent to the NodeManager via
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
- as part of {@link ContainerLaunchContext#getServiceData()}
- @return the servicesData for this application.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Initialization context for {@link AuxiliaryService} when starting an
- application.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ApplicationInitializationContext -->
- <!-- start class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
- <class name="ApplicationTerminationContext" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationTerminationContext" type="org.apache.hadoop.yarn.api.records.ApplicationId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getApplicationId" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link ApplicationId} of the application being stopped.
- @return applications ID]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Initialization context for {@link AuxiliaryService} when stopping an
- application.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ApplicationTerminationContext -->
- <!-- start class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
- <class name="AuxiliaryService" extends="org.apache.hadoop.service.AbstractService"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="AuxiliaryService" type="java.lang.String"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </constructor>
- <method name="getRecoveryPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the path specific to this auxiliary service to use for recovery.
- @return state storage path or null if recovery is not enabled]]>
- </doc>
- </method>
- <method name="initializeApplication"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="initAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationInitializationContext"/>
- <doc>
- <![CDATA[A new application is started on this NodeManager. This is a signal to
- this {@link AuxiliaryService} about the application initialization.
- @param initAppContext context for the application's initialization]]>
- </doc>
- </method>
- <method name="stopApplication"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stopAppContext" type="org.apache.hadoop.yarn.server.api.ApplicationTerminationContext"/>
- <doc>
- <![CDATA[An application is finishing on this NodeManager. This is a signal to this
- {@link AuxiliaryService} about the same.
- @param stopAppContext context for the application termination]]>
- </doc>
- </method>
- <method name="getMetaData" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retrieve meta-data for this {@link AuxiliaryService}. Applications using
- this {@link AuxiliaryService} SHOULD know the format of the meta-data -
- ideally each service should provide a method to parse out the information
- to the applications. One example of meta-data is contact information so
- that applications can access the service remotely. This will only be called
- after the service's {@link #start()} method has finished. the result may be
- cached.
- <p>
- The information is passed along to applications via
- {@link StartContainersResponse#getAllServicesMetaData()} that is returned by
- {@link ContainerManagementProtocol#startContainers(StartContainersRequest)}
- </p>
- @return meta-data for this service that should be made available to
- applications.]]>
- </doc>
- </method>
- <method name="initializeContainer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="initContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerInitializationContext"/>
- <doc>
- <![CDATA[A new container is started on this NodeManager. This is a signal to
- this {@link AuxiliaryService} about the container initialization.
- This method is called when the NodeManager receives the container launch
- command from the ApplicationMaster and before the container process is
- launched.
- @param initContainerContext context for the container's initialization]]>
- </doc>
- </method>
- <method name="stopContainer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="stopContainerContext" type="org.apache.hadoop.yarn.server.api.ContainerTerminationContext"/>
- <doc>
- <![CDATA[A container is finishing on this NodeManager. This is a signal to this
- {@link AuxiliaryService} about the same.
- @param stopContainerContext context for the container termination]]>
- </doc>
- </method>
- <method name="setRecoveryPath"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="recoveryPath" type="org.apache.hadoop.fs.Path"/>
- <doc>
- <![CDATA[Set the path for this auxiliary service to use for storing state
- that will be used during recovery.
- @param recoveryPath where recoverable state should be stored]]>
- </doc>
- </method>
- <doc>
- <![CDATA[A generic service that will be started by the NodeManager. This is a service
- that administrators have to configure on each node by setting
- {@link YarnConfiguration#NM_AUX_SERVICES}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.AuxiliaryService -->
- <!-- start class org.apache.hadoop.yarn.server.api.ContainerContext -->
- <class name="ContainerContext" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get user of the container being initialized or stopped.
- @return the user]]>
- </doc>
- </method>
- <method name="getContainerId" return="org.apache.hadoop.yarn.api.records.ContainerId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link ContainerId} of the container being initialized or stopped.
- @return the container ID]]>
- </doc>
- </method>
- <method name="getResource" return="org.apache.hadoop.yarn.api.records.Resource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link Resource} the resource capability allocated to the container
- being initialized or stopped.
- @return the resource capability.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Base context class for {@link AuxiliaryService} initializing and stopping a
- container.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ContainerContext -->
- <!-- start class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
- <class name="ContainerInitializationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Initialization context for {@link AuxiliaryService} when starting a
- container.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ContainerInitializationContext -->
- <!-- start class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
- <class name="ContainerTerminationContext" extends="org.apache.hadoop.yarn.server.api.ContainerContext"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Termination context for {@link AuxiliaryService} when stopping a
- container.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ContainerTerminationContext -->
- </package>
- </api>
|