12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185201862018720188201892019020191201922019320194201952019620197201982019920200202012020220203202042020520206202072020820209202102021120212202132021420215202162021720218202192022020221202222022320224202252022620227202282022920230202312023220233202342023520236202372023820239202402024120242202432024420245202462024720248202492025020251202522025320254202552025620257202582025920260202612026220263202642026520266202672026820269202702027120272202732027420275202762027720278202792028020281202822028320284202852028620287202882028920290202912029220293202942029520296202972029820299203002030120302203032030420305203062030720308203092031020311203122031320314203152031620317203182031920320203212032220323203242032520326203272032820329203302033120332203332033420335203362033720338203392034020341203422034320344203452034620347203482034920350203512035220353203542035520356203572035820359203602036120362203632036420365203662036720368203692037020371203722037320374203752037620377203782037920380203812038220383203842038520386203872038820389203902039120392203932039420395203962039720398203992040020401204022040320404204052040620407204082040920410204112041220413204142041520416204172041820419204202042120422204232042420425204262042720428204292043020431204322043320434204352043620437204382043920440204412044220443204442044520446204472044820449204502045120452204532045420455204562045720458204592046020461204622046320464204652046620467204682046920470204712047220473204742047520476204772047820479204802048120482204832048420485204862048720488204892049020491204922049320494204952049620497204982049920500205012050220503205042050520506205072050820509205102051120512205132051420515205162051720518205192052020521205222052320524205252052620527205282052920530205312053220533205342053520536205372053820539205402054120542205432054420545205462054720548205492055020551205522055320554205552055620557205582055920560205612056220563205642056520566205672056820569205702057120572205732057420575205762057720578205792058020581205822058320584205852058620587205882058920590205912059220593205942059520596205972059820599206002060120602206032060420605206062060720608206092061020611206122061320614206152061620617206182061920620206212062220623206242062520626206272062820629206302063120632206332063420635206362063720638206392064020641206422064320644206452064620647206482064920650206512065220653206542065520656206572065820659206602066120662206632066420665206662066720668206692067020671206722067320674206752067620677206782067920680206812068220683206842068520686206872068820689206902069120692206932069420695206962069720698206992070020701207022070320704207052070620707207082070920710207112071220713207142071520716207172071820719207202072120722207232072420725207262072720728207292073020731207322073320734207352073620737207382073920740207412074220743207442074520746207472074820749207502075120752207532075420755207562075720758207592076020761207622076320764207652076620767207682076920770207712077220773207742077520776207772077820779207802078120782207832078420785207862078720788207892079020791207922079320794207952079620797207982079920800208012080220803208042080520806208072080820809208102081120812208132081420815208162081720818208192082020821208222082320824208252082620827208282082920830208312083220833208342083520836208372083820839208402084120842208432084420845208462084720848208492085020851208522085320854208552085620857208582085920860208612086220863208642086520866208672086820869208702087120872208732087420875208762087720878208792088020881208822088320884208852088620887208882088920890208912089220893208942089520896208972089820899209002090120902209032090420905209062090720908209092091020911209122091320914209152091620917209182091920920209212092220923209242092520926209272092820929209302093120932209332093420935209362093720938209392094020941209422094320944209452094620947209482094920950209512095220953209542095520956209572095820959209602096120962209632096420965209662096720968209692097020971209722097320974209752097620977209782097920980209812098220983209842098520986209872098820989209902099120992209932099420995209962099720998209992100021001210022100321004210052100621007210082100921010210112101221013210142101521016210172101821019210202102121022210232102421025210262102721028210292103021031210322103321034210352103621037210382103921040210412104221043210442104521046210472104821049210502105121052210532105421055210562105721058210592106021061210622106321064210652106621067210682106921070210712107221073210742107521076210772107821079210802108121082210832108421085210862108721088210892109021091210922109321094210952109621097210982109921100211012110221103211042110521106211072110821109211102111121112211132111421115211162111721118211192112021121211222112321124211252112621127211282112921130211312113221133211342113521136211372113821139211402114121142211432114421145211462114721148211492115021151211522115321154211552115621157211582115921160211612116221163211642116521166211672116821169211702117121172211732117421175211762117721178211792118021181211822118321184211852118621187211882118921190211912119221193211942119521196211972119821199212002120121202212032120421205212062120721208212092121021211212122121321214212152121621217212182121921220212212122221223212242122521226212272122821229212302123121232212332123421235212362123721238212392124021241212422124321244212452124621247212482124921250212512125221253212542125521256212572125821259212602126121262212632126421265212662126721268212692127021271212722127321274212752127621277212782127921280212812128221283212842128521286212872128821289212902129121292212932129421295212962129721298212992130021301213022130321304213052130621307213082130921310213112131221313213142131521316213172131821319213202132121322213232132421325213262132721328213292133021331213322133321334213352133621337213382133921340213412134221343213442134521346213472134821349213502135121352213532135421355213562135721358213592136021361213622136321364213652136621367213682136921370213712137221373213742137521376213772137821379213802138121382213832138421385213862138721388213892139021391213922139321394213952139621397213982139921400214012140221403214042140521406214072140821409214102141121412214132141421415214162141721418214192142021421214222142321424214252142621427214282142921430214312143221433214342143521436214372143821439214402144121442214432144421445214462144721448214492145021451214522145321454214552145621457214582145921460214612146221463214642146521466214672146821469214702147121472214732147421475214762147721478214792148021481214822148321484214852148621487214882148921490214912149221493214942149521496214972149821499215002150121502215032150421505215062150721508215092151021511215122151321514215152151621517215182151921520215212152221523215242152521526215272152821529215302153121532215332153421535215362153721538215392154021541215422154321544215452154621547215482154921550215512155221553215542155521556215572155821559215602156121562215632156421565215662156721568215692157021571215722157321574215752157621577215782157921580215812158221583215842158521586215872158821589215902159121592215932159421595215962159721598215992160021601216022160321604216052160621607216082160921610216112161221613216142161521616216172161821619216202162121622216232162421625216262162721628216292163021631216322163321634216352163621637216382163921640216412164221643216442164521646216472164821649216502165121652216532165421655216562165721658216592166021661216622166321664216652166621667216682166921670216712167221673216742167521676216772167821679216802168121682216832168421685216862168721688216892169021691216922169321694216952169621697216982169921700217012170221703217042170521706217072170821709217102171121712217132171421715217162171721718217192172021721217222172321724217252172621727217282172921730217312173221733217342173521736217372173821739217402174121742217432174421745217462174721748217492175021751217522175321754217552175621757217582175921760217612176221763217642176521766217672176821769217702177121772217732177421775217762177721778217792178021781217822178321784217852178621787217882178921790217912179221793217942179521796217972179821799218002180121802218032180421805218062180721808218092181021811218122181321814218152181621817218182181921820218212182221823218242182521826218272182821829218302183121832218332183421835218362183721838218392184021841218422184321844218452184621847218482184921850218512185221853218542185521856218572185821859218602186121862218632186421865218662186721868218692187021871218722187321874218752187621877218782187921880218812188221883218842188521886218872188821889218902189121892218932189421895218962189721898218992190021901219022190321904219052190621907219082190921910219112191221913219142191521916219172191821919219202192121922219232192421925219262192721928219292193021931219322193321934219352193621937219382193921940219412194221943219442194521946219472194821949219502195121952219532195421955219562195721958219592196021961219622196321964219652196621967219682196921970219712197221973219742197521976219772197821979219802198121982219832198421985219862198721988219892199021991219922199321994219952199621997219982199922000220012200222003220042200522006220072200822009220102201122012220132201422015220162201722018220192202022021220222202322024220252202622027220282202922030220312203222033220342203522036220372203822039220402204122042220432204422045220462204722048220492205022051220522205322054220552205622057220582205922060220612206222063220642206522066220672206822069220702207122072220732207422075220762207722078220792208022081220822208322084220852208622087220882208922090220912209222093220942209522096220972209822099221002210122102221032210422105221062210722108221092211022111221122211322114221152211622117221182211922120221212212222123221242212522126221272212822129221302213122132221332213422135221362213722138221392214022141221422214322144221452214622147221482214922150221512215222153221542215522156221572215822159221602216122162221632216422165221662216722168221692217022171221722217322174221752217622177221782217922180221812218222183221842218522186221872218822189221902219122192221932219422195221962219722198221992220022201222022220322204222052220622207222082220922210222112221222213222142221522216222172221822219222202222122222222232222422225222262222722228222292223022231222322223322234222352223622237222382223922240222412224222243222442224522246222472224822249222502225122252222532225422255222562225722258222592226022261222622226322264222652226622267222682226922270222712227222273222742227522276222772227822279222802228122282222832228422285222862228722288222892229022291222922229322294222952229622297222982229922300223012230222303223042230522306223072230822309223102231122312223132231422315223162231722318223192232022321223222232322324223252232622327223282232922330223312233222333223342233522336223372233822339223402234122342223432234422345223462234722348223492235022351223522235322354223552235622357223582235922360223612236222363223642236522366223672236822369223702237122372223732237422375223762237722378223792238022381223822238322384223852238622387223882238922390223912239222393223942239522396223972239822399224002240122402224032240422405224062240722408224092241022411224122241322414224152241622417224182241922420224212242222423224242242522426224272242822429224302243122432224332243422435224362243722438224392244022441224422244322444224452244622447224482244922450224512245222453224542245522456224572245822459224602246122462224632246422465224662246722468224692247022471224722247322474224752247622477224782247922480224812248222483224842248522486224872248822489224902249122492224932249422495224962249722498224992250022501225022250322504225052250622507225082250922510225112251222513225142251522516225172251822519225202252122522225232252422525225262252722528225292253022531225322253322534225352253622537225382253922540225412254222543225442254522546225472254822549225502255122552225532255422555225562255722558225592256022561225622256322564225652256622567225682256922570225712257222573225742257522576225772257822579225802258122582225832258422585225862258722588225892259022591225922259322594225952259622597225982259922600226012260222603226042260522606226072260822609226102261122612226132261422615226162261722618226192262022621226222262322624226252262622627226282262922630226312263222633226342263522636226372263822639226402264122642226432264422645226462264722648226492265022651226522265322654226552265622657226582265922660226612266222663226642266522666226672266822669226702267122672226732267422675226762267722678226792268022681226822268322684226852268622687226882268922690226912269222693226942269522696226972269822699227002270122702227032270422705227062270722708227092271022711227122271322714227152271622717227182271922720227212272222723227242272522726227272272822729227302273122732227332273422735227362273722738227392274022741227422274322744227452274622747227482274922750227512275222753227542275522756227572275822759227602276122762227632276422765227662276722768227692277022771227722277322774227752277622777227782277922780227812278222783227842278522786227872278822789227902279122792227932279422795227962279722798227992280022801228022280322804228052280622807228082280922810228112281222813228142281522816228172281822819228202282122822228232282422825228262282722828228292283022831228322283322834228352283622837228382283922840228412284222843228442284522846228472284822849228502285122852228532285422855228562285722858228592286022861228622286322864228652286622867228682286922870228712287222873228742287522876228772287822879228802288122882228832288422885228862288722888228892289022891228922289322894228952289622897228982289922900229012290222903229042290522906229072290822909229102291122912229132291422915229162291722918229192292022921229222292322924229252292622927229282292922930229312293222933229342293522936229372293822939229402294122942229432294422945229462294722948229492295022951229522295322954229552295622957229582295922960229612296222963229642296522966229672296822969229702297122972229732297422975229762297722978229792298022981229822298322984229852298622987229882298922990229912299222993229942299522996229972299822999230002300123002230032300423005230062300723008230092301023011230122301323014230152301623017230182301923020230212302223023230242302523026230272302823029230302303123032230332303423035230362303723038230392304023041230422304323044230452304623047230482304923050230512305223053230542305523056230572305823059230602306123062230632306423065230662306723068230692307023071230722307323074230752307623077230782307923080230812308223083230842308523086230872308823089230902309123092230932309423095230962309723098230992310023101231022310323104231052310623107231082310923110231112311223113231142311523116231172311823119231202312123122231232312423125231262312723128231292313023131231322313323134231352313623137231382313923140231412314223143231442314523146231472314823149231502315123152231532315423155231562315723158231592316023161231622316323164231652316623167231682316923170231712317223173231742317523176231772317823179231802318123182231832318423185231862318723188231892319023191231922319323194231952319623197231982319923200232012320223203232042320523206232072320823209232102321123212232132321423215232162321723218232192322023221232222322323224232252322623227232282322923230232312323223233232342323523236232372323823239232402324123242232432324423245232462324723248232492325023251232522325323254232552325623257232582325923260232612326223263232642326523266232672326823269232702327123272232732327423275232762327723278232792328023281232822328323284232852328623287232882328923290232912329223293232942329523296232972329823299233002330123302233032330423305233062330723308233092331023311233122331323314233152331623317233182331923320233212332223323233242332523326233272332823329233302333123332233332333423335233362333723338233392334023341233422334323344233452334623347233482334923350233512335223353233542335523356233572335823359233602336123362233632336423365233662336723368233692337023371233722337323374233752337623377233782337923380233812338223383233842338523386233872338823389233902339123392233932339423395233962339723398233992340023401234022340323404234052340623407234082340923410234112341223413234142341523416234172341823419234202342123422234232342423425234262342723428234292343023431234322343323434234352343623437234382343923440234412344223443234442344523446234472344823449234502345123452234532345423455234562345723458234592346023461234622346323464234652346623467234682346923470234712347223473234742347523476234772347823479234802348123482234832348423485234862348723488234892349023491234922349323494234952349623497234982349923500235012350223503235042350523506235072350823509235102351123512235132351423515235162351723518235192352023521235222352323524235252352623527235282352923530235312353223533235342353523536235372353823539235402354123542235432354423545235462354723548235492355023551235522355323554235552355623557235582355923560235612356223563235642356523566235672356823569235702357123572235732357423575235762357723578235792358023581235822358323584235852358623587235882358923590235912359223593235942359523596235972359823599236002360123602236032360423605236062360723608236092361023611236122361323614236152361623617236182361923620236212362223623236242362523626236272362823629236302363123632236332363423635236362363723638236392364023641236422364323644236452364623647236482364923650236512365223653236542365523656236572365823659236602366123662236632366423665236662366723668236692367023671236722367323674236752367623677236782367923680236812368223683236842368523686236872368823689236902369123692236932369423695236962369723698236992370023701237022370323704237052370623707237082370923710237112371223713237142371523716237172371823719237202372123722237232372423725237262372723728237292373023731237322373323734237352373623737237382373923740237412374223743237442374523746237472374823749237502375123752237532375423755237562375723758237592376023761237622376323764237652376623767237682376923770237712377223773237742377523776237772377823779237802378123782237832378423785237862378723788237892379023791237922379323794237952379623797237982379923800238012380223803238042380523806238072380823809238102381123812238132381423815238162381723818238192382023821238222382323824238252382623827238282382923830238312383223833238342383523836238372383823839238402384123842238432384423845238462384723848238492385023851238522385323854238552385623857238582385923860238612386223863238642386523866238672386823869238702387123872238732387423875238762387723878238792388023881238822388323884238852388623887238882388923890238912389223893238942389523896238972389823899239002390123902239032390423905239062390723908239092391023911239122391323914239152391623917239182391923920239212392223923239242392523926239272392823929239302393123932239332393423935239362393723938239392394023941239422394323944239452394623947239482394923950239512395223953239542395523956239572395823959239602396123962239632396423965239662396723968239692397023971239722397323974239752397623977239782397923980239812398223983239842398523986239872398823989239902399123992239932399423995239962399723998239992400024001240022400324004240052400624007240082400924010240112401224013240142401524016240172401824019240202402124022240232402424025240262402724028240292403024031240322403324034240352403624037240382403924040240412404224043240442404524046240472404824049240502405124052240532405424055240562405724058240592406024061240622406324064240652406624067240682406924070240712407224073240742407524076240772407824079240802408124082240832408424085240862408724088240892409024091240922409324094240952409624097240982409924100241012410224103241042410524106241072410824109241102411124112241132411424115241162411724118241192412024121241222412324124241252412624127241282412924130241312413224133241342413524136241372413824139241402414124142241432414424145241462414724148241492415024151241522415324154241552415624157241582415924160241612416224163241642416524166241672416824169241702417124172241732417424175241762417724178241792418024181241822418324184241852418624187241882418924190241912419224193241942419524196241972419824199242002420124202242032420424205242062420724208242092421024211242122421324214242152421624217242182421924220242212422224223242242422524226242272422824229242302423124232242332423424235242362423724238242392424024241242422424324244242452424624247242482424924250242512425224253242542425524256242572425824259242602426124262242632426424265242662426724268242692427024271242722427324274242752427624277242782427924280242812428224283242842428524286242872428824289242902429124292242932429424295242962429724298242992430024301243022430324304243052430624307243082430924310243112431224313243142431524316243172431824319243202432124322243232432424325243262432724328243292433024331243322433324334243352433624337243382433924340243412434224343243442434524346243472434824349243502435124352243532435424355243562435724358243592436024361243622436324364243652436624367243682436924370243712437224373243742437524376243772437824379243802438124382243832438424385243862438724388243892439024391243922439324394243952439624397243982439924400244012440224403244042440524406244072440824409244102441124412244132441424415244162441724418244192442024421244222442324424244252442624427244282442924430244312443224433244342443524436244372443824439244402444124442244432444424445244462444724448244492445024451244522445324454244552445624457244582445924460244612446224463244642446524466244672446824469244702447124472244732447424475244762447724478244792448024481244822448324484244852448624487244882448924490244912449224493244942449524496244972449824499245002450124502245032450424505245062450724508245092451024511245122451324514245152451624517245182451924520245212452224523245242452524526245272452824529245302453124532245332453424535245362453724538245392454024541245422454324544245452454624547245482454924550245512455224553245542455524556245572455824559245602456124562245632456424565245662456724568245692457024571245722457324574245752457624577245782457924580245812458224583245842458524586245872458824589245902459124592245932459424595245962459724598245992460024601246022460324604246052460624607246082460924610246112461224613246142461524616246172461824619246202462124622246232462424625246262462724628246292463024631246322463324634246352463624637246382463924640246412464224643246442464524646246472464824649246502465124652246532465424655246562465724658246592466024661246622466324664246652466624667246682466924670246712467224673246742467524676246772467824679246802468124682246832468424685246862468724688246892469024691246922469324694246952469624697246982469924700247012470224703247042470524706247072470824709247102471124712247132471424715247162471724718247192472024721247222472324724247252472624727247282472924730247312473224733247342473524736247372473824739247402474124742247432474424745247462474724748247492475024751247522475324754247552475624757247582475924760247612476224763247642476524766247672476824769247702477124772247732477424775247762477724778247792478024781247822478324784247852478624787247882478924790247912479224793247942479524796247972479824799248002480124802248032480424805248062480724808248092481024811248122481324814248152481624817248182481924820248212482224823248242482524826248272482824829248302483124832248332483424835248362483724838248392484024841248422484324844248452484624847248482484924850248512485224853248542485524856248572485824859248602486124862248632486424865248662486724868248692487024871248722487324874248752487624877248782487924880248812488224883248842488524886248872488824889248902489124892248932489424895248962489724898248992490024901249022490324904249052490624907249082490924910249112491224913249142491524916249172491824919249202492124922249232492424925249262492724928249292493024931249322493324934249352493624937249382493924940249412494224943249442494524946249472494824949249502495124952249532495424955249562495724958249592496024961249622496324964249652496624967249682496924970249712497224973249742497524976249772497824979249802498124982249832498424985249862498724988249892499024991249922499324994249952499624997249982499925000250012500225003250042500525006250072500825009250102501125012250132501425015250162501725018250192502025021250222502325024250252502625027250282502925030250312503225033250342503525036250372503825039250402504125042250432504425045250462504725048250492505025051250522505325054250552505625057250582505925060250612506225063250642506525066250672506825069250702507125072250732507425075250762507725078250792508025081250822508325084250852508625087250882508925090250912509225093250942509525096250972509825099251002510125102251032510425105251062510725108251092511025111251122511325114251152511625117251182511925120251212512225123251242512525126251272512825129251302513125132251332513425135251362513725138251392514025141251422514325144251452514625147251482514925150251512515225153251542515525156251572515825159251602516125162251632516425165251662516725168251692517025171251722517325174251752517625177251782517925180251812518225183251842518525186251872518825189251902519125192251932519425195251962519725198251992520025201252022520325204252052520625207252082520925210252112521225213252142521525216252172521825219252202522125222252232522425225252262522725228252292523025231252322523325234252352523625237252382523925240252412524225243252442524525246252472524825249252502525125252252532525425255252562525725258252592526025261252622526325264252652526625267252682526925270252712527225273252742527525276252772527825279252802528125282252832528425285252862528725288252892529025291252922529325294252952529625297252982529925300253012530225303253042530525306253072530825309253102531125312253132531425315253162531725318253192532025321253222532325324253252532625327253282532925330253312533225333253342533525336253372533825339253402534125342253432534425345253462534725348253492535025351253522535325354253552535625357253582535925360253612536225363253642536525366253672536825369253702537125372253732537425375253762537725378253792538025381253822538325384253852538625387253882538925390253912539225393253942539525396253972539825399254002540125402254032540425405254062540725408254092541025411254122541325414254152541625417254182541925420254212542225423254242542525426254272542825429254302543125432254332543425435254362543725438254392544025441254422544325444254452544625447254482544925450254512545225453254542545525456254572545825459254602546125462254632546425465254662546725468254692547025471254722547325474254752547625477254782547925480254812548225483254842548525486254872548825489254902549125492254932549425495254962549725498254992550025501255022550325504255052550625507255082550925510255112551225513255142551525516255172551825519255202552125522255232552425525255262552725528255292553025531255322553325534255352553625537255382553925540255412554225543255442554525546255472554825549255502555125552255532555425555255562555725558255592556025561255622556325564255652556625567255682556925570255712557225573255742557525576255772557825579255802558125582255832558425585255862558725588255892559025591255922559325594255952559625597255982559925600256012560225603256042560525606256072560825609256102561125612256132561425615256162561725618256192562025621256222562325624256252562625627256282562925630256312563225633256342563525636256372563825639256402564125642256432564425645256462564725648256492565025651256522565325654256552565625657256582565925660256612566225663256642566525666256672566825669256702567125672256732567425675256762567725678256792568025681256822568325684256852568625687256882568925690256912569225693256942569525696256972569825699257002570125702257032570425705257062570725708257092571025711257122571325714257152571625717257182571925720257212572225723257242572525726257272572825729257302573125732257332573425735257362573725738257392574025741257422574325744257452574625747257482574925750257512575225753257542575525756257572575825759257602576125762257632576425765257662576725768257692577025771257722577325774257752577625777257782577925780257812578225783257842578525786257872578825789257902579125792257932579425795257962579725798257992580025801258022580325804258052580625807258082580925810258112581225813258142581525816258172581825819258202582125822258232582425825258262582725828258292583025831258322583325834258352583625837258382583925840258412584225843258442584525846258472584825849258502585125852258532585425855258562585725858258592586025861258622586325864258652586625867258682586925870258712587225873258742587525876258772587825879258802588125882258832588425885258862588725888258892589025891258922589325894258952589625897258982589925900259012590225903259042590525906259072590825909259102591125912259132591425915259162591725918259192592025921259222592325924259252592625927259282592925930259312593225933259342593525936259372593825939259402594125942259432594425945259462594725948259492595025951259522595325954259552595625957259582595925960259612596225963259642596525966259672596825969259702597125972259732597425975259762597725978259792598025981259822598325984259852598625987259882598925990259912599225993259942599525996259972599825999260002600126002260032600426005260062600726008260092601026011260122601326014260152601626017260182601926020260212602226023260242602526026260272602826029260302603126032260332603426035260362603726038260392604026041260422604326044260452604626047260482604926050260512605226053260542605526056260572605826059260602606126062260632606426065260662606726068260692607026071260722607326074260752607626077260782607926080260812608226083260842608526086260872608826089260902609126092260932609426095260962609726098260992610026101261022610326104261052610626107261082610926110261112611226113261142611526116261172611826119261202612126122261232612426125261262612726128261292613026131261322613326134261352613626137261382613926140261412614226143261442614526146261472614826149261502615126152261532615426155261562615726158261592616026161261622616326164261652616626167261682616926170261712617226173261742617526176261772617826179261802618126182261832618426185261862618726188261892619026191261922619326194261952619626197261982619926200262012620226203262042620526206262072620826209262102621126212262132621426215262162621726218262192622026221262222622326224262252622626227262282622926230262312623226233262342623526236262372623826239262402624126242262432624426245262462624726248262492625026251262522625326254262552625626257262582625926260262612626226263262642626526266262672626826269262702627126272262732627426275262762627726278262792628026281262822628326284262852628626287262882628926290262912629226293262942629526296262972629826299263002630126302263032630426305263062630726308263092631026311263122631326314263152631626317263182631926320263212632226323263242632526326263272632826329263302633126332263332633426335263362633726338263392634026341263422634326344263452634626347263482634926350263512635226353263542635526356263572635826359263602636126362263632636426365263662636726368263692637026371263722637326374263752637626377263782637926380263812638226383263842638526386263872638826389263902639126392263932639426395263962639726398263992640026401264022640326404264052640626407 |
- <?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
- <!-- Generated by the JDiff Javadoc doclet -->
- <!-- (http://www.jdiff.org) -->
- <!-- on Fri Jul 29 14:08:01 GMT 2022 -->
- <api
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:noNamespaceSchemaLocation='api.xsd'
- name="Apache Hadoop YARN API 3.3.4"
- jdversion="1.0.9">
- <!-- Command line arguments = -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -verbose -classpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/classes:/maven/org/apache/hadoop/thirdparty/hadoop-shaded-guava/1.1.1/hadoop-shaded-guava-1.1.1.jar:/maven/javax/xml/bind/jaxb-api/2.2.11/jaxb-api-2.2.11.jar:/build/source/hadoop-common-project/hadoop-common/target/hadoop-common-3.3.4.jar:/maven/com/google/guava/guava/27.0-jre/guava-27.0-jre.jar:/maven/com/google/guava/failureaccess/1.0/failureaccess-1.0.jar:/maven/com/google/guava/listenablefuture/9999.0-empty-to-avoid-conflict-with-guava/listenablefuture-9999.0-empty-to-avoid-conflict-with-guava.jar:/maven/org/checkerframework/checker-qual/2.5.2/checker-qual-2.5.2.jar:/maven/com/google/j2objc/j2objc-annotations/1.1/j2objc-annotations-1.1.jar:/maven/org/codehaus/mojo/animal-sniffer-annotations/1.17/animal-sniffer-annotations-1.17.jar:/maven/commons-cli/commons-cli/1.2/commons-cli-1.2.jar:/maven/org/apache/commons/commons-math3/3.1.1/commons-math3-3.1.1.jar:/maven/org/apache/httpcomponents/httpclient/4.5.13/httpclient-4.5.13.jar:/maven/org/apache/httpcomponents/httpcore/4.4.13/httpcore-4.4.13.jar:/maven/commons-codec/commons-codec/1.15/commons-codec-1.15.jar:/maven/commons-io/commons-io/2.8.0/commons-io-2.8.0.jar:/maven/commons-net/commons-net/3.6/commons-net-3.6.jar:/maven/commons-collections/commons-collections/3.2.2/commons-collections-3.2.2.jar:/maven/javax/servlet/javax.servlet-api/3.1.0/javax.servlet-api-3.1.0.jar:/maven/jakarta/activation/jakarta.activation-api/1.2.1/jakarta.activation-api-1.2.1.jar:/maven/org/eclipse/jetty/jetty-server/9.4.43.v20210629/jetty-server-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-http/9.4.43.v20210629/jetty-http-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-io/9.4.43.v20210629/jetty-io-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-util/9.4.43.v20210629/jetty-util-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-servlet/9.4.43.v20210629/jetty-servlet-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-security/9.4.43.v20210629/jetty-security-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-util-ajax/9.4.43.v20210629/jetty-util-ajax-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-webapp/9.4.43.v20210629/jetty-webapp-9.4.43.v20210629.jar:/maven/org/eclipse/jetty/jetty-xml/9.4.43.v20210629/jetty-xml-9.4.43.v20210629.jar:/maven/javax/servlet/jsp/jsp-api/2.1/jsp-api-2.1.jar:/maven/com/sun/jersey/jersey-core/1.19/jersey-core-1.19.jar:/maven/javax/ws/rs/jsr311-api/1.1.1/jsr311-api-1.1.1.jar:/maven/com/sun/jersey/jersey-servlet/1.19/jersey-servlet-1.19.jar:/maven/com/sun/jersey/jersey-json/1.19/jersey-json-1.19.jar:/maven/org/codehaus/jettison/jettison/1.1/jettison-1.1.jar:/maven/com/sun/xml/bind/jaxb-impl/2.2.3-1/jaxb-impl-2.2.3-1.jar:/maven/org/codehaus/jackson/jackson-core-asl/1.9.13/jackson-core-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-mapper-asl/1.9.13/jackson-mapper-asl-1.9.13.jar:/maven/org/codehaus/jackson/jackson-jaxrs/1.9.13/jackson-jaxrs-1.9.13.jar:/maven/org/codehaus/jackson/jackson-xc/1.9.13/jackson-xc-1.9.13.jar:/maven/com/sun/jersey/jersey-server/1.19/jersey-server-1.19.jar:/maven/commons-logging/commons-logging/1.1.3/commons-logging-1.1.3.jar:/maven/ch/qos/reload4j/reload4j/1.2.22/reload4j-1.2.22.jar:/maven/commons-beanutils/commons-beanutils/1.9.4/commons-beanutils-1.9.4.jar:/maven/org/apache/commons/commons-configuration2/2.1.1/commons-configuration2-2.1.1.jar:/maven/org/apache/commons/commons-lang3/3.12.0/commons-lang3-3.12.0.jar:/maven/org/apache/commons/commons-text/1.4/commons-text-1.4.jar:/maven/org/slf4j/slf4j-api/1.7.36/slf4j-api-1.7.36.jar:/maven/org/apache/avro/avro/1.7.7/avro-1.7.7.jar:/maven/com/thoughtworks/paranamer/paranamer/2.3/paranamer-2.3.jar:/maven/com/google/re2j/re2j/1.1/re2j-1.1.jar:/maven/com/google/code/gson/gson/2.8.9/gson-2.8.9.jar:/build/source/hadoop-common-project/hadoop-auth/target/hadoop-auth-3.3.4.jar:/maven/com/nimbusds/nimbus-jose-jwt/9.8.1/nimbus-jose-jwt-9.8.1.jar:/maven/com/github/stephenc/jcip/jcip-annotations/1.0-1/jcip-annotations-1.0-1.jar:/maven/net/minidev/json-smart/2.4.7/json-smart-2.4.7.jar:/maven/net/minidev/accessors-smart/2.4.7/accessors-smart-2.4.7.jar:/maven/org/ow2/asm/asm/5.0.4/asm-5.0.4.jar:/maven/org/apache/curator/curator-framework/4.2.0/curator-framework-4.2.0.jar:/maven/org/apache/kerby/kerb-simplekdc/1.0.1/kerb-simplekdc-1.0.1.jar:/maven/org/apache/kerby/kerb-client/1.0.1/kerb-client-1.0.1.jar:/maven/org/apache/kerby/kerby-config/1.0.1/kerby-config-1.0.1.jar:/maven/org/apache/kerby/kerb-common/1.0.1/kerb-common-1.0.1.jar:/maven/org/apache/kerby/kerb-crypto/1.0.1/kerb-crypto-1.0.1.jar:/maven/org/apache/kerby/kerb-util/1.0.1/kerb-util-1.0.1.jar:/maven/org/apache/kerby/token-provider/1.0.1/token-provider-1.0.1.jar:/maven/org/apache/kerby/kerb-admin/1.0.1/kerb-admin-1.0.1.jar:/maven/org/apache/kerby/kerb-server/1.0.1/kerb-server-1.0.1.jar:/maven/org/apache/kerby/kerb-identity/1.0.1/kerb-identity-1.0.1.jar:/maven/org/apache/kerby/kerby-xdr/1.0.1/kerby-xdr-1.0.1.jar:/maven/com/jcraft/jsch/0.1.55/jsch-0.1.55.jar:/maven/org/apache/curator/curator-client/4.2.0/curator-client-4.2.0.jar:/maven/org/apache/curator/curator-recipes/4.2.0/curator-recipes-4.2.0.jar:/maven/com/google/code/findbugs/jsr305/3.0.2/jsr305-3.0.2.jar:/maven/org/apache/zookeeper/zookeeper/3.5.6/zookeeper-3.5.6.jar:/maven/org/apache/zookeeper/zookeeper-jute/3.5.6/zookeeper-jute-3.5.6.jar:/maven/org/apache/yetus/audience-annotations/0.5.0/audience-annotations-0.5.0.jar:/maven/org/apache/commons/commons-compress/1.21/commons-compress-1.21.jar:/maven/org/apache/kerby/kerb-core/1.0.1/kerb-core-1.0.1.jar:/maven/org/apache/kerby/kerby-pkix/1.0.1/kerby-pkix-1.0.1.jar:/maven/org/apache/kerby/kerby-asn1/1.0.1/kerby-asn1-1.0.1.jar:/maven/org/apache/kerby/kerby-util/1.0.1/kerby-util-1.0.1.jar:/maven/com/fasterxml/jackson/core/jackson-databind/2.12.7/jackson-databind-2.12.7.jar:/maven/com/fasterxml/jackson/core/jackson-core/2.12.7/jackson-core-2.12.7.jar:/maven/org/codehaus/woodstox/stax2-api/4.2.1/stax2-api-4.2.1.jar:/maven/com/fasterxml/woodstox/woodstox-core/5.3.0/woodstox-core-5.3.0.jar:/maven/dnsjava/dnsjava/2.1.7/dnsjava-2.1.7.jar:/maven/org/xerial/snappy/snappy-java/1.1.8.2/snappy-java-1.1.8.2.jar:/build/source/hadoop-common-project/hadoop-annotations/target/hadoop-annotations-3.3.4.jar:/usr/lib/jvm/java-8-openjdk-amd64/lib/tools.jar:/maven/com/google/protobuf/protobuf-java/2.5.0/protobuf-java-2.5.0.jar:/maven/org/apache/hadoop/thirdparty/hadoop-shaded-protobuf_3_7/1.1.1/hadoop-shaded-protobuf_3_7-1.1.1.jar:/maven/com/fasterxml/jackson/core/jackson-annotations/2.12.7/jackson-annotations-2.12.7.jar:/maven/xerces/xercesImpl/2.12.2/xercesImpl-2.12.2.jar:/maven/xml-apis/xml-apis/1.4.01/xml-apis-1.4.01.jar -sourcepath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/src/main/java -doclet org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet -docletpath /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/hadoop-annotations.jar:/build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/jdiff.jar -apidir /build/source/hadoop-yarn-project/hadoop-yarn/hadoop-yarn-api/target/site/jdiff/xml -apiname Apache Hadoop YARN API 3.3.4 -->
- <package name="org.apache.hadoop.yarn.ams">
- </package>
- <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">
- <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
- <method name="getNewApplication" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewApplicationResponse"
- abstract="true" 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="true" 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
- @see #getNewApplication(GetNewApplicationRequest)]]>
- </doc>
- </method>
- <method name="failApplicationAttempt" return="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest"/>
- <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 fail an application attempt.</p>
- <p>The client, via {@link FailApplicationAttemptRequest} provides the
- {@link ApplicationAttemptId} of the attempt to be failed.</p>
- <p> In secure mode,the <code>ResourceManager</code> verifies access to the
- application, queue etc. before failing the attempt.</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 fail an attempt
- @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="forceKillApplication" return="org.apache.hadoop.yarn.api.protocolrecords.KillApplicationResponse"
- abstract="true" 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="getClusterMetrics" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterMetricsResponse"
- abstract="true" 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="getClusterNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodesResponse"
- abstract="true" 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="true" 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="true" 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="moveApplicationAcrossQueues" return="org.apache.hadoop.yarn.api.protocolrecords.MoveApplicationAcrossQueuesResponse"
- abstract="true" 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="getNewReservation" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest"/>
- <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 ReservationId} for
- submitting new reservations.</p>
- <p>The <code>ResourceManager</code> responds with a new, unique,
- {@link ReservationId} which is used by the client to submit
- a new reservation.</p>
- @param request to get a new <code>ReservationId</code>
- @return response containing the new <code>ReservationId</code> to be used
- to submit a new reservation
- @throws YarnException if the reservation system is not enabled.
- @throws IOException on IO failures.
- @see #submitReservation(ReservationSubmissionRequest)]]>
- </doc>
- </method>
- <method name="submitReservation" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationSubmissionResponse"
- abstract="true" 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="true" 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="true" 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="listReservations" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"/>
- <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 the list of reservations in a plan.
- The reservationId will be used to search for reservations to list if it is
- provided. Otherwise, it will select active reservations within the
- startTime and endTime (inclusive).
- </p>
- @param request to list reservations in a plan. Contains fields to select
- String queue, ReservationId reservationId, long startTime,
- long endTime, and a bool includeReservationAllocations.
- queue: Required. Cannot be null or empty. Refers to the
- reservable queue in the scheduler that was selected when
- creating a reservation submission
- {@link ReservationSubmissionRequest}.
- reservationId: Optional. If provided, other fields will
- be ignored.
- startTime: Optional. If provided, only reservations that
- end after the startTime will be selected. This defaults
- to 0 if an invalid number is used.
- endTime: Optional. If provided, only reservations that
- start on or before endTime will be selected. This defaults
- to Long.MAX_VALUE if an invalid number is used.
- includeReservationAllocations: Optional. Flag that
- determines whether the entire reservation allocations are
- to be returned. Reservation allocations are subject to
- change in the event of re-planning as described by
- {@code ReservationDefinition}.
- @return response that contains information about reservations that are
- being searched for.
- @throws YarnException if the request is invalid
- @throws IOException on IO failures]]>
- </doc>
- </method>
- <method name="getNodeToLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToLabelsResponse"
- abstract="true" 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="getLabelsToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetLabelsToNodesRequest"/>
- <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 labels to nodes mappings
- in existing cluster
- </p>
- @param request
- @return labels to nodes mappings
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="getClusterNodeLabels" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeLabelsResponse"
- abstract="true" 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>
- <method name="updateApplicationPriority" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest"/>
- <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 set priority of an application.
- </p>
- @param request to set priority of an application
- @return an empty response
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="signalToContainer" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"/>
- <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 signal a container. For example,
- the client can send command OUTPUT_THREAD_DUMP to dump threads of the
- container.</p>
- <p>The client, via {@link SignalContainerRequest} provides the
- id of the container and the signal command. </p>
- <p> In secure mode,the <code>ResourceManager</code> verifies access to the
- application before signaling the container.
- The user needs to have <code>MODIFY_APP</code> permission.</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 signal a container
- @return <code>ResourceManager</code> returns an empty response
- on success and throws an exception on rejecting the request
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="updateApplicationTimeouts" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest"/>
- <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 set ApplicationTimeouts of an application.
- The UpdateApplicationTimeoutsRequest should have timeout value with
- absolute time with ISO8601 format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
- </p>
- <b>Note:</b> If application timeout value is less than or equal to current
- time then update application throws YarnException.
- @param request to set ApplicationTimeouts of an application
- @return a response with updated timeouts.
- @throws YarnException if update request has empty values or application is
- in completing states.
- @throws IOException on IO failures]]>
- </doc>
- </method>
- <method name="getResourceProfiles" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest"/>
- <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 all the resource profiles that are
- available on the ResourceManager.
- </p>
- @param request request to get all the resource profiles
- @return Response containing a map of the profile name to Resource
- capabilities
- @throws YARNFeatureNotEnabledException if resource-profile is disabled
- @throws YarnException if any error happens inside YARN
- @throws IOException in case of other errors]]>
- </doc>
- </method>
- <method name="getResourceProfile" return="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface to get the details for a specific resource profile.
- </p>
- @param request request to get the details of a resource profile
- @return Response containing the details for a particular resource profile
- @throws YARNFeatureNotEnabledException if resource-profile is disabled
- @throws YarnException if any error happens inside YARN
- @throws IOException in case of other errors]]>
- </doc>
- </method>
- <method name="getResourceTypeInfo" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The interface to get the details for a specific resource profile.
- </p>
- @param request request to get the details of a resource profile
- @return Response containing the details for a particular resource profile
- @throws YarnException if any error happens inside YARN
- @throws IOException in case of other errors]]>
- </doc>
- </method>
- <method name="getAttributesToNodes" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest"/>
- <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 attributes to nodes mappings
- available in ResourceManager.
- </p>
- @param request request to get details of attributes to nodes mapping.
- @return Response containing the details of attributes to nodes mappings.
- @throws YarnException if any error happens inside YARN
- @throws IOException incase of other errors]]>
- </doc>
- </method>
- <method name="getClusterNodeAttributes" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest"/>
- <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 attributes available in
- ResourceManager.
- </p>
- @param request request to get node attributes collection of this cluster.
- @return Response containing node attributes collection.
- @throws YarnException if any error happens inside YARN.
- @throws IOException incase of other errors.]]>
- </doc>
- </method>
- <method name="getNodesToAttributes" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest"/>
- <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 attributes mappings.
- in existing cluster.
- </p>
- @param request request to get nodes to attributes mapping.
- @return nodes to attributes mappings.
- @throws YarnException if any error happens inside YARN.
- @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="KEYSTORE_FILE_LOCATION_ENV_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The file into which the keystore containing the AM's certificate is
- written.]]>
- </doc>
- </field>
- <field name="KEYSTORE_PASSWORD_ENV_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The password for the AM's keystore.]]>
- </doc>
- </field>
- <field name="TRUSTSTORE_FILE_LOCATION_ENV_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The file into which the truststore containing the AM's certificate is
- written.]]>
- </doc>
- </field>
- <field name="TRUSTSTORE_PASSWORD_ENV_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The password for the AM's truststore.]]>
- </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>
- <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.ContainerLaunchType -->
- <class name="ApplicationConstants.ContainerLaunchType" 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.ContainerLaunchType[]"
- 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.ContainerLaunchType"
- 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[The type of launch for the container.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.ApplicationConstants.ContainerLaunchType -->
- <!-- start interface org.apache.hadoop.yarn.api.ApplicationHistoryProtocol -->
- <interface name="ApplicationHistoryProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="org.apache.hadoop.yarn.api.ApplicationBaseProtocol"/>
- <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="true" 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>
- <p>
- Re-register is only allowed for <code>Unmanaged Application Master</code>
- (UAM) HA, with
- {@link org.apache.hadoop.yarn.api.records.ApplicationSubmissionContext#getKeepContainersAcrossApplicationAttempts()}
- set to true.
- </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="true" 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="true" 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.ClientSCMProtocol -->
- <interface name="ClientSCMProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="use" return="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest"/>
- <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 claim a resource with the
- <code>SharedCacheManager.</code> The client uses a checksum to identify the
- resource and an {@link ApplicationId} to identify which application will be
- using the resource.
- </p>
- <p>
- The <code>SharedCacheManager</code> responds with whether or not the
- resource exists in the cache. If the resource exists, a <code>Path</code>
- to the resource in the shared cache is returned. If the resource does not
- exist, the response is empty.
- </p>
- @param request request to claim a resource in the shared cache
- @return response indicating if the resource is already in the cache
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="release" return="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest"/>
- <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 release a resource with the
- <code>SharedCacheManager.</code> This method is called once an application
- is no longer using a claimed resource in the shared cache. The client uses
- a checksum to identify the resource and an {@link ApplicationId} to
- identify which application is releasing the resource.
- </p>
- <p>
- Note: This method is an optimization and the client is not required to call
- it for correctness.
- </p>
- <p>
- Currently the <code>SharedCacheManager</code> sends an empty response.
- </p>
- @param request request to release a resource in the shared cache
- @return (empty) response on releasing the resource
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The protocol between clients and the <code>SharedCacheManager</code> to claim
- and release resources in the shared cache.
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.api.ClientSCMProtocol -->
- <!-- 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="true" 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]]>
- </doc>
- </method>
- <method name="stopContainers" return="org.apache.hadoop.yarn.api.protocolrecords.StopContainersResponse"
- abstract="true" 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="true" 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>
- <method name="increaseContainersResource" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"/>
- <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
- resource increase of running containers on the <code>NodeManager</code>.
- </p>
- @param request
- request to increase resource of a list of containers
- @return response which includes a list of containerIds of containers
- whose resource has been successfully increased and a
- containerId-to-exception map for failed requests.
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <method name="updateContainer" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest"/>
- <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
- resource update of running containers on the <code>NodeManager</code>.
- </p>
- @param request
- request to update resource of a list of containers
- @return response which includes a list of containerIds of containers
- whose resource has been successfully updated and a
- containerId-to-exception map for failed requests.
- @throws YarnException Exception specific to YARN
- @throws IOException IOException thrown from NodeManager]]>
- </doc>
- </method>
- <method name="signalToContainer" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- </method>
- <method name="localize" return="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Localize resources required by the container.
- Currently, this API only works for running containers.
- @param request Specify the resources to be localized.
- @return Response that the localize request is accepted.
- @throws YarnException Exception specific to YARN
- @throws IOException IOException thrown from the RPC layer.]]>
- </doc>
- </method>
- <method name="reInitializeContainer" return="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[ReInitialize the Container with a new Launch Context.
- @param request Specify the new ContainerLaunchContext.
- @return Response that the ReInitialize request is accepted.
- @throws YarnException Exception specific to YARN.
- @throws IOException IOException thrown from the RPC layer.]]>
- </doc>
- </method>
- <method name="restartContainer" return="org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse"
- 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"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Restart the container.
- @param containerId Container Id.
- @return Response that the restart request is accepted.
- @throws YarnException Exception specific to YARN.
- @throws IOException IOException thrown from the RPC layer.]]>
- </doc>
- </method>
- <method name="rollbackLastReInitialization" return="org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse"
- 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"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Rollback the Last ReInitialization if possible.
- @param containerId Container Id.
- @return Response that the rollback request is accepted.
- @throws YarnException Exception specific to YARN.
- @throws IOException IOException thrown from the RPC layer.]]>
- </doc>
- </method>
- <method name="commitLastReInitialization" return="org.apache.hadoop.yarn.api.protocolrecords.CommitResponse"
- 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"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Commit the Last ReInitialization if possible. Once the reinitialization
- has been committed, It cannot be rolled back.
- @param containerId Container Id.
- @return Response that the commit request is accepted.
- @throws YarnException Exception specific to YARN.
- @throws IOException IOException thrown from the RPC layer.]]>
- </doc>
- </method>
- <method name="getLocalizationStatuses" return="org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[API to request for the localization statuses of requested containers from
- the Node Manager.
- @param request {@link GetLocalizationStatusesRequest} which includes the
- container ids of all the containers whose localization
- statuses are needed.
- @return {@link GetLocalizationStatusesResponse} which contains the
- localization statuses of all the requested containers.
- @throws YarnException Exception specific to YARN.
- @throws IOException IOException thrown from the RPC layer.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The protocol between an <code>ApplicationMaster</code> and a
- <code>NodeManager</code> to start/stop and increase resource of 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="trackingUrl" type="java.lang.String"/>
- </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="updateRequests" type="java.util.List"/>
- <param name="resourceBlacklistRequest" type="org.apache.hadoop.yarn.api.records.ResourceBlacklistRequest"/>
- </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="getUpdateRequests" 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 container update requests being sent by the
- <code>ApplicationMaster</code>.
- @return list of {@link UpdateContainerRequest}
- being sent by the
- <code>ApplicationMaster</code>.]]>
- </doc>
- </method>
- <method name="setUpdateRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updateRequests" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list of container update requests to inform the
- <code>ResourceManager</code> about the containers that need to be
- updated.
- @param updateRequests list of <code>UpdateContainerRequest</code> for
- containers to be updated]]>
- </doc>
- </method>
- <method name="getSchedulingRequests" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of Scheduling requests being sent by the
- <code>ApplicationMaster</code>.
- @return list of {@link SchedulingRequest} being sent by the
- <code>ApplicationMaster</code>.]]>
- </doc>
- </method>
- <method name="setSchedulingRequests"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="schedulingRequests" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list of Scheduling requests to inform the
- <code>ResourceManager</code> about the application's resource requirements
- (potentially including allocation tags and placement constraints).
- @param schedulingRequests list of {@link SchedulingRequest} to update
- the <code>ResourceManager</code> about the application's resource
- requirements.]]>
- </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 tracking url update for this heartbeat.
- @return tracking url to update this application with]]>
- </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 new tracking url for this application.
- @param trackingUrl the new tracking url]]>
- </doc>
- </method>
- <method name="newBuilder" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </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>
- <li>
- A list of {@link UpdateContainerRequest} to inform
- the <code>ResourceManager</code> about the change in
- requirements of running containers.
- </li>
- </ul>
-
- @see ApplicationMasterProtocol#allocate(AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder -->
- <class name="AllocateRequest.AllocateRequestBuilder" extends="java.lang.Object"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="responseId" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="responseId" type="int"/>
- <doc>
- <![CDATA[Set the <code>responseId</code> of the request.
- @see AllocateRequest#setResponseId(int)
- @param responseId <code>responseId</code> of the request
- @return {@link AllocateRequestBuilder}]]>
- </doc>
- </method>
- <method name="progress" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="progress" type="float"/>
- <doc>
- <![CDATA[Set the <code>progress</code> of the request.
- @see AllocateRequest#setProgress(float)
- @param progress <code>progress</code> of the request
- @return {@link AllocateRequestBuilder}]]>
- </doc>
- </method>
- <method name="askList" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="askList" type="java.util.List"/>
- <doc>
- <![CDATA[Set the <code>askList</code> of the request.
- @see AllocateRequest#setAskList(List)
- @param askList <code>askList</code> of the request
- @return {@link AllocateRequestBuilder}]]>
- </doc>
- </method>
- <method name="releaseList" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="releaseList" type="java.util.List"/>
- <doc>
- <![CDATA[Set the <code>releaseList</code> of the request.
- @see AllocateRequest#setReleaseList(List)
- @param releaseList <code>releaseList</code> of the request
- @return {@link AllocateRequestBuilder}]]>
- </doc>
- </method>
- <method name="resourceBlacklistRequest" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
- abstract="false" 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> of the request.
- @see AllocateRequest#setResourceBlacklistRequest(
- ResourceBlacklistRequest)
- @param resourceBlacklistRequest
- <code>resourceBlacklistRequest</code> of the request
- @return {@link AllocateRequestBuilder}]]>
- </doc>
- </method>
- <method name="updateRequests" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updateRequests" type="java.util.List"/>
- <doc>
- <![CDATA[Set the <code>updateRequests</code> of the request.
- @see AllocateRequest#setUpdateRequests(List)
- @param updateRequests <code>updateRequests</code> of the request
- @return {@link AllocateRequestBuilder}]]>
- </doc>
- </method>
- <method name="schedulingRequests" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="schedulingRequests" type="java.util.List"/>
- <doc>
- <![CDATA[Set the <code>schedulingRequests</code> of the request.
- @see AllocateRequest#setSchedulingRequests(List)
- @param schedulingRequests <code>SchedulingRequest</code> of the request
- @return {@link AllocateRequestBuilder}]]>
- </doc>
- </method>
- <method name="trackingUrl" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="trackingUrl" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>trackingUrl</code> of the request.
- @see AllocateRequest#setTrackingUrl(String)
- @param trackingUrl new tracking url
- @return {@link AllocateRequestBuilder}]]>
- </doc>
- </method>
- <method name="build" return="org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return generated {@link AllocateRequest} object.
- @return {@link AllocateRequest}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Class to construct instances of {@link AllocateRequest} with specific
- options.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest.AllocateRequestBuilder -->
- <!-- 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="amRMToken" type="org.apache.hadoop.yarn.api.records.Token"/>
- <param name="updatedContainers" type="java.util.List"/>
- <param name="collectorInfo" type="org.apache.hadoop.yarn.api.records.CollectorInfo"/>
- </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[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>
- 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.
- @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[Get the list of NMTokens required for communicating with NM. New NMTokens
- issued only if
- <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>
- 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.
- @return list of NMTokens required for communicating with NM]]>
- </doc>
- </method>
- <method name="getUpdatedContainers" 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 updated containers by
- <code>ResourceManager</code>.
- @return list of newly increased containers]]>
- </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>
- <method name="getApplicationPriority" 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[Priority of the application
- @return get application priority]]>
- </doc>
- </method>
- <method name="getCollectorInfo" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The data associated with the collector that belongs to this app. Contains
- address and token alongwith identification information.
- @return The data of collector that belong to this attempt]]>
- </doc>
- </method>
- <method name="getUpdateErrors" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the list of container update errors to inform the
- Application Master about the container updates that could not be
- satisfied due to error.
- @return List of Update Container Errors.]]>
- </doc>
- </method>
- <method name="setUpdateErrors"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updateErrors" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list of container update errors to inform the
- Application Master about the container updates that could not be
- satisfied due to error.
- @param updateErrors list of <code>UpdateContainerError</code> for
- containers updates requests that were in error]]>
- </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[Get the list of running containers as viewed by
- <code>ResourceManager</code> from previous application attempts which
- have not been reported to the Application Master yet.
- <br>
- These containers were recovered by the RM after the application master
- had already registered. This may happen after RM restart when some NMs get
- delayed in connecting to the RM and reporting the active containers.
- Since they were not reported in the registration
- response, they are reported in the response to the AM heartbeat.
- @return the list of running containers as viewed by
- <code>ResourceManager</code> from previous application attempts.]]>
- </doc>
- </method>
- <method name="getRejectedSchedulingRequests" 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 all SchedulingRequests that the RM has rejected between
- this allocate call and the previous one.
- @return List of RejectedSchedulingRequests.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the <code>ResourceManager</code> the
- <code>ApplicationMaster</code> during resource negotiation.
- <p>
- The response, includes:
- <ul>
- <li>Response ID to track duplicate responses.</li>
- <li>
- An AMCommand sent by ResourceManager to let the
- {@code ApplicationMaster} take some actions (resync, shutdown etc.).
- </li>
- <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>
- <li>
- A list of {@link Container} representing the containers
- whose resource has been increased.
- </li>
- <li>
- A list of {@link Container} representing the containers
- whose resource has been decreased.
- </li>
- </ul>
-
- @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.CommitResponse -->
- <class name="CommitResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CommitResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Response to Commit Container Request.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.CommitResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest -->
- <class name="ContainerUpdateRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerUpdateRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containersToIncrease" type="java.util.List"/>
- </method>
- <method name="getContainersToUpdate" 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 container tokens to be used for authorization during
- container resource update.
- <p>
- Note: {@link NMToken} will be used for authenticating communication with
- {@code NodeManager}.
- @return the list of container tokens to be used for authorization during
- container resource update.
- @see NMToken]]>
- </doc>
- </method>
- <method name="setContainersToUpdate"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containersToUpdate" type="java.util.List"/>
- <doc>
- <![CDATA[Set container tokens to be used during container resource increase.
- The token is acquired from
- <code>AllocateResponse.getUpdatedContainers</code>.
- The token contains the container id and resource capability required for
- container resource update.
- @param containersToUpdate the list of container tokens to be used
- for container resource increase.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by <code>Application Master</code> to the
- <code>Node Manager</code> to change the resource quota of a container.</p>
- @see ContainerManagementProtocol#updateContainer(ContainerUpdateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse -->
- <class name="ContainerUpdateResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerUpdateResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="successfullyUpdatedContainers" type="java.util.List"/>
- <param name="failedRequests" type="java.util.Map"/>
- </method>
- <method name="getSuccessfullyUpdatedContainers" 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 containers whose resource
- have been successfully update.
- @return the list of containerIds of containers whose resource have
- been successfully updated.]]>
- </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 each container for failed requests.
- @return map of containerId-to-exception]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>NodeManager</code> to the
- <code>ApplicationMaster</code> when asked to update container resource.
- </p>
- @see ContainerManagementProtocol#updateContainer(ContainerUpdateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ContainerUpdateResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
- <class name="FailApplicationAttemptRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FailApplicationAttemptRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attemptId" 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 the attempt to be failed.
- @return <code>ApplicationAttemptId</code> of the 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"/>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
- to fail an application attempt.</p>
- <p>The request includes the {@link ApplicationAttemptId} of the attempt to
- be failed.</p>
- @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
- <class name="FailApplicationAttemptResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FailApplicationAttemptResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
- failing an application attempt.</p>
- <p>Currently it's empty.</p>
- @see ApplicationClientProtocol#failApplicationAttempt(FailApplicationAttemptRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.FailApplicationAttemptResponse -->
- <!-- 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[The finalization request sent by the {@code ApplicationMaster} to
- inform the {@code ResourceManager} about its completion.
- <p>
- The final request includes details such:
- <ul>
- <li>Final state of the {@code ApplicationMaster}</li>
- <li>
- Diagnostic information in case of failure of the
- {@code ApplicationMaster}
- </li>
- <li>Tracking URL</li>
- </ul>
- @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.
- @return true if the application has unregistered with the RM,
- false otherwise]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the <code>ResourceManager</code> to a
- <code>ApplicationMaster</code> on it's completion.
- <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.GetAllResourceProfilesRequest -->
- <class name="GetAllResourceProfilesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetAllResourceProfilesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Request class for getting all the resource profiles from the RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse -->
- <class name="GetAllResourceProfilesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetAllResourceProfilesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setResourceProfiles"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="profiles" type="java.util.Map"/>
- </method>
- <method name="getResourceProfiles" return="java.util.Map"
- abstract="true" 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>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Response class for getting all the resource profiles from the RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceProfilesResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest -->
- <class name="GetAllResourceTypeInfoRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetAllResourceTypeInfoRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Request class for getting all the resource profiles from the RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse -->
- <class name="GetAllResourceTypeInfoResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetAllResourceTypeInfoResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setResourceTypeInfo"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceTypes" type="java.util.List"/>
- </method>
- <method name="getResourceTypeInfo" return="java.util.List"
- abstract="true" 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>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Response class for getting all the resource profiles from the RM.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAllResourceTypeInfoResponse -->
- <!-- 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.lang3.Range"/>
- <param name="finishRange" type="org.apache.commons.lang3.Range"/>
- <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)
- @return a report of Applications in {@link 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)
- @return a report of Applications in {@link 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)
- @return a report of Applications in {@link 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)
- @return a report of Applications in <code>GetApplicationsRequest</code>]]>
- </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.GetAttributesToNodesRequest -->
- <class name="GetAttributesToNodesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetAttributesToNodesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest"
- 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.GetAttributesToNodesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributes" type="java.util.Set"/>
- </method>
- <method name="setNodeAttributes"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributes" type="java.util.Set"/>
- <doc>
- <![CDATA[Set node attributeKeys for which the mapping of hostname to attribute value
- is required.
- @param attributes Set of NodeAttributeKey provided.]]>
- </doc>
- </method>
- <method name="getNodeAttributes" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get node attributeKeys for which mapping of hostname to attribute value is
- required.
- @return Set of NodeAttributeKey]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request from clients to get node to attribute value mapping for all or
- given set of Node AttributeKey's in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getAttributesToNodes
- (GetAttributesToNodesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse -->
- <class name="GetAttributesToNodesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetAttributesToNodesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse"
- 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="setAttributeToNodes"
- 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="getAttributesToNodes" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get mapping of NodeAttributeKey to its associated mapping of list of
- NodeToAttributeValue associated with attribute.
- @return Map of node attributes to list of NodeToAttributeValue.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- node to attribute value mapping for all or given set of Node AttributeKey's.
- </p>
- @see ApplicationClientProtocol#getAttributesToNodes
- (GetAttributesToNodesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetAttributesToNodesResponse -->
- <!-- 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[The response sent by the <code>ResourceManager</code> to a client
- requesting cluster metrics.
-
- @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.GetClusterNodeAttributesRequest -->
- <class name="GetClusterNodeAttributesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodeAttributesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Create new instance of GetClusterNodeAttributesRequest.
- @return GetClusterNodeAttributesRequest is returned.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request from clients to get node attributes in the cluster from the
- <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getClusterNodeAttributes
- (GetClusterNodeAttributesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse -->
- <class name="GetClusterNodeAttributesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetClusterNodeAttributesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributes" type="java.util.Set"/>
- <doc>
- <![CDATA[Create instance of GetClusterNodeAttributesResponse.
- @param attributes
- @return GetClusterNodeAttributesResponse.]]>
- </doc>
- </method>
- <method name="setNodeAttributes"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributes" type="java.util.Set"/>
- <doc>
- <![CDATA[Set node attributes to the response.
- @param attributes Map of Node attributeKey to Type.]]>
- </doc>
- </method>
- <method name="getNodeAttributes" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get node attributes from the response.
- @return Node attributes.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- a node attributes in cluster.
- </p>
- @see ApplicationClientProtocol#getClusterNodeAttributes
- (GetClusterNodeAttributesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetClusterNodeAttributesResponse -->
- <!-- 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="Use {@link #newInstance(List)} instead.">
- <param name="labels" type="java.util.Set"/>
- <doc>
- <![CDATA[Creates a new instance.
- @param labels Node labels
- @return response
- @deprecated Use {@link #newInstance(List)} instead.]]>
- </doc>
- </method>
- <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.List"/>
- </method>
- <method name="setNodeLabelList"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="labels" type="java.util.List"/>
- </method>
- <method name="getNodeLabelList" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setNodeLabels"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #setNodeLabelList(List)} instead.">
- <param name="labels" type="java.util.Set"/>
- <doc>
- <![CDATA[Set node labels to the response.
- @param labels Node labels
- @deprecated Use {@link #setNodeLabelList(List)} instead.]]>
- </doc>
- </method>
- <method name="getNodeLabels" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="Use {@link #getNodeLabelList()} instead.">
- <doc>
- <![CDATA[Get node labels of the response.
- @return Node labels
- @deprecated Use {@link #getNodeLabelList()} instead.]]>
- </doc>
- </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.
- @return the set of {@link NodeState}]]>
- </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.
- @param states the set of {@link NodeState}]]>
- </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[The request sent by the <code>ApplicationMaster</code> to the
- <code>NodeManager</code> to get {@link ContainerStatus} of requested
- containers.
-
- @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
- @return map of containerId-to-exception]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the <code>NodeManager</code> to the
- <code>ApplicationMaster</code> when asked to obtain the
- <code>ContainerStatus</code> of requested containers.
-
- @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}.
- @return the delegation tokens]]>
- </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.GetLocalizationStatusesRequest -->
- <class name="GetLocalizationStatusesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetLocalizationStatusesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesRequest"
- 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 container IDs of the containers for which the localization
- statuses are needed.
- @return the list of container IDs.]]>
- </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[Sets the list of container IDs of containers for which the localization
- statuses are needed.
- @param containerIds the list of container IDs.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The request sent by an application master to the node manager to get
- {@link LocalizationStatus}es of containers.
- @see ContainerManagementProtocol#getLocalizationStatuses(
- GetLocalizationStatusesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesResponse -->
- <class name="GetLocalizationStatusesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetLocalizationStatusesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="statuses" type="java.util.Map"/>
- <param name="failedRequests" type="java.util.Map"/>
- </method>
- <method name="getLocalizationStatuses" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get all the container localization statuses.
- @return container localization statuses.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the node manager to an application master when
- localization statuses are requested.
- @see ContainerManagementProtocol#getLocalizationStatuses(
- GetLocalizationStatusesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetLocalizationStatusesResponse -->
- <!-- 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.GetNewReservationRequest -->
- <class name="GetNewReservationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNewReservationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest"
- 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 {@code ReservationId} for
- submitting an reservation.</p>
- {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
- <class name="GetNewReservationResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNewReservationResponse"
- 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 a new {@link ReservationId} to be used to submit a reservation.
- @return a {@link ReservationId} representing the unique id to identify
- a reservation with which it was submitted.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client for
- a request to get a new {@link ReservationId} for submitting reservations.</p>
- <p>Clients can submit an reservation with the returned
- {@link ReservationId}.</p>
- {@code ApplicationClientProtocol#getNewReservation(GetNewReservationRequest)}]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNewReservationResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest -->
- <class name="GetNodesToAttributesRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNodesToAttributesRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostNames" type="java.util.Set"/>
- </method>
- <method name="setHostNames"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostnames" type="java.util.Set"/>
- <doc>
- <![CDATA[Set hostnames for which mapping is required.
- @param hostnames]]>
- </doc>
- </method>
- <method name="getHostNames" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get hostnames for which mapping is required.
- @return Set of hostnames.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request from clients to get nodes to attributes mapping
- in the cluster from the <code>ResourceManager</code>.
- </p>
- @see ApplicationClientProtocol#getNodesToAttributes
- (GetNodesToAttributesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse -->
- <class name="GetNodesToAttributesResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetNodesToAttributesResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse"
- 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="setNodeToAttributes"
- 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="getNodeToAttributes" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get hostnames to NodeAttributes mapping.
- @return Map of host to attributes.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to a client requesting
- nodes to attributes mapping.
- </p>
- @see ApplicationClientProtocol#getNodesToAttributes
- (GetNodesToAttributesRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetNodesToAttributesResponse -->
- <!-- 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</em> 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[The response sent by the {@code ResourceManager} to a client
- requesting information about queues in the system.
- <p>
- The response includes a {@link QueueInfo} which has details such as
- queue name, used/total capacities, running applications, child queues etc.
-
- @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.GetResourceProfileRequest -->
- <class name="GetResourceProfileRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetResourceProfileRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="profile" type="java.lang.String"/>
- </method>
- <method name="setProfileName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="profileName" type="java.lang.String"/>
- </method>
- <method name="getProfileName" return="java.lang.String"
- abstract="true" 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>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Request class for getting the details for a particular resource profile.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse -->
- <class name="GetResourceProfileResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="GetResourceProfileResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </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 resources that will be allocated if the profile was used.
- @return the resources that will be allocated if the profile was used.]]>
- </doc>
- </method>
- <method name="setResource"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="r" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <doc>
- <![CDATA[Set the resources that will be allocated if the profile is used.
- @param r Set the resources that will be allocated if the profile is used.]]>
- </doc>
- </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>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[Response class for getting the details for a particular resource profile.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.GetResourceProfileResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
- <class name="IncreaseContainersResourceRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="IncreaseContainersResourceRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containersToIncrease" type="java.util.List"/>
- </method>
- <method name="getContainersToIncrease" 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 container tokens to be used for authorization during
- container resource increase.
- <p>
- Note: {@link NMToken} will be used for authenticating communication with
- {@code NodeManager}.
- @return the list of container tokens to be used for authorization during
- container resource increase.
- @see NMToken]]>
- </doc>
- </method>
- <method name="setContainersToIncrease"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containersToIncrease" type="java.util.List"/>
- <doc>
- <![CDATA[Set container tokens to be used during container resource increase.
- The token is acquired from
- <code>AllocateResponse.getIncreasedContainers</code>.
- The token contains the container id and resource capability required for
- container resource increase.
- @param containersToIncrease the list of container tokens to be used
- for container resource increase.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by <code>Application Master</code> to the
- <code>Node Manager</code> to change the resource quota of a container.</p>
- @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
- <class name="IncreaseContainersResourceResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="IncreaseContainersResourceResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getSuccessfullyIncreasedContainers" 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 containers whose resource
- have been successfully increased.
- @return the list of containerIds of containers whose resource have
- been successfully increased.]]>
- </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 each container for failed requests.
- @return map of containerId-to-exception]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>NodeManager</code> to the
- <code>ApplicationMaster</code> when asked to increase container resource.
- </p>
- @see ContainerManagementProtocol#increaseContainersResource(IncreaseContainersResourceRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.IncreaseContainersResourceResponse -->
- <!-- 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>
- <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>diagnostics</em> to which the application is being killed.
- @return <em>diagnostics</em> to which the application is being killed]]>
- </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 the <em>diagnostics</em> to which the application is being killed.
- @param diagnostics <em>diagnostics</em> to which the application is being
- killed]]>
- </doc>
- </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.
- @return true if the process of killing application has completed,
- false otherwise]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the <code>ResourceManager</code> to the client aborting
- a submitted application.
- <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.
-
- @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="true"
- 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} is
- responding.
- @return the <em>RPC port</em> on which the {@code ApplicationMaster}
- 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} is
- responding.
- @param port <em>RPC port</em> on which the {@code ApplicationMaster}
- 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>
- <method name="getPlacementConstraints" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return all Placement Constraints specified at the Application level. The
- mapping is from a set of allocation tags to a
- <code>PlacementConstraint</code> associated with the tags, i.e., each
- {@link org.apache.hadoop.yarn.api.records.SchedulingRequest} that has those
- tags will be placed taking into account the corresponding constraint.
- @return A map of Placement Constraints.]]>
- </doc>
- </method>
- <method name="setPlacementConstraints"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="placementConstraints" type="java.util.Map"/>
- <doc>
- <![CDATA[Set Placement Constraints applicable to the
- {@link org.apache.hadoop.yarn.api.records.SchedulingRequest}s
- of this application.
- The mapping is from a set of allocation tags to a
- <code>PlacementConstraint</code> associated with the tags.
- For example:
- Map <
- <hb_regionserver> -> node_anti_affinity,
- <hb_regionserver, hb_master> -> rack_affinity,
- ...
- >
- @param placementConstraints Placement Constraint Mapping.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The request sent by the {@code ApplicationMaster} to {@code ResourceManager}
- on registration.
- <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>
-
- @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>
- @return ClientToAMToken master key]]>
- </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>
- @return the queue that the application was placed in.]]>
- </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>
- <method name="getResourceProfiles" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get list of supported resource profiles from RM.
- @return a map of resource profiles and its capabilities.]]>
- </doc>
- </method>
- <method name="getResourceTypes" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get available resource types supported by RM.
- @return a Map of RM settings]]>
- </doc>
- </method>
- <doc>
- <![CDATA[The response sent by the {@code ResourceManager} to a new
- {@code ApplicationMaster} on registration.
- <p>
- The response contains critical details such as:
- <ul>
- <li>Maximum capability for allocated resources in the cluster.</li>
- <li>{@code ApplicationACL}s for the application.</li>
- <li>ClientToAMToken master key.</li>
- </ul>
-
- @see ApplicationMasterProtocol#registerApplicationMaster(RegisterApplicationMasterRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RegisterApplicationMasterResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest -->
- <class name="ReInitializeContainerRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReInitializeContainerRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest"
- 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"/>
- <param name="containerLaunchContext" type="org.apache.hadoop.yarn.api.records.ContainerLaunchContext"/>
- <param name="autoCommit" type="boolean"/>
- <doc>
- <![CDATA[Creates a new instance of the ReInitializationContainerRequest.
- @param containerId Container Id.
- @param containerLaunchContext Container Launch Context.
- @param autoCommit AutoCommit.
- @return ReInitializationContainerRequest.]]>
- </doc>
- </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 to re-initialize.
- @return <code>ContainerId</code> of the container to re-initialize.]]>
- </doc>
- </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> to re-initialize the container
- with.
- @return <code>ContainerLaunchContext</code> of to re-initialize the
- container with.]]>
- </doc>
- </method>
- <method name="getAutoCommit" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Check if AutoCommit is set for this ReInitialization.
- @return If AutoCommit is set for this ReInitialization.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This encapsulates all the required fields needed for a Container
- ReInitialization.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse -->
- <class name="ReInitializeContainerResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReInitializeContainerResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[The response to the {@link ReInitializeContainerRequest}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReInitializeContainerResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
- <class name="ReleaseSharedCacheResourceRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReleaseSharedCacheResourceRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAppId" 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 resource to be released.
- @return <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="setAppId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the resource to be released.
- @param id <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="getResourceKey" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>key</code> of the resource to be released.
- @return <code>key</code>]]>
- </doc>
- </method>
- <method name="setResourceKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>key</code> of the resource to be released.
- @param key unique identifier for the resource]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request from clients to release a resource in the shared cache.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
- <class name="ReleaseSharedCacheResourceResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReleaseSharedCacheResourceResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[<p>
- The response to clients from the <code>SharedCacheManager</code> when
- releasing a resource in the shared cache.
- </p>
- <p>
- Currently, this is empty.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReleaseSharedCacheResourceResponse -->
- <!-- 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.ReservationListRequest -->
- <class name="ReservationListRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationListRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <param name="reservationId" type="java.lang.String"/>
- <param name="startTime" type="long"/>
- <param name="endTime" type="long"/>
- <param name="includeReservationAllocations" type="boolean"/>
- <doc>
- <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
- reservations to list if it is provided. Otherwise, it will select active
- reservations within the startTime and endTime (inclusive).
- @param queue Required. Cannot be null or empty. Refers to the reservable
- queue in the scheduler that was selected when creating a
- reservation submission {@link ReservationSubmissionRequest}.
- @param reservationId Optional. String representation of
- {@code ReservationId} If provided, other fields will
- be ignored.
- @param startTime Optional. If provided, only reservations that
- end after the startTime will be selected. This defaults
- to 0 if an invalid number is used.
- @param endTime Optional. If provided, only reservations that
- start on or before endTime will be selected. This defaults
- to Long.MAX_VALUE if an invalid number is used.
- @param includeReservationAllocations Optional. Flag that
- determines whether the entire reservation allocations are
- to be returned. Reservation allocations are subject to
- change in the event of re-planning as described by
- {@code ReservationDefinition}.
- @return the list of reservations via {@link ReservationListRequest}]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <param name="reservationId" type="java.lang.String"/>
- <param name="includeReservationAllocations" type="boolean"/>
- <doc>
- <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
- reservations to list if it is provided. Otherwise, it will select active
- reservations within the startTime and endTime (inclusive).
- @param queue Required. Cannot be null or empty. Refers to the reservable
- queue in the scheduler that was selected when creating a
- reservation submission {@link ReservationSubmissionRequest}.
- @param reservationId Optional. String representation of
- {@code ReservationId} If provided, other fields will
- be ignored.
- @param includeReservationAllocations Optional. Flag that
- determines whether the entire reservation allocations are
- to be returned. Reservation allocations are subject to
- change in the event of re-planning as described by
- {@code ReservationDefinition}.
- @return the list of reservations via {@link ReservationListRequest}]]>
- </doc>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- <param name="reservationId" type="java.lang.String"/>
- <doc>
- <![CDATA[The {@link ReservationListRequest} will use the reservationId to search for
- reservations to list if it is provided. Otherwise, it will select active
- reservations within the startTime and endTime (inclusive).
- @param queue Required. Cannot be null or empty. Refers to the reservable
- queue in the scheduler that was selected when creating a
- reservation submission {@link ReservationSubmissionRequest}.
- @param reservationId Optional. String representation of
- {@code ReservationId} If provided, other fields will
- be ignored.
- @return the list of reservations via {@link ReservationListRequest}]]>
- </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 queue name to use to find reservations.
- @return the queue name to use to find reservations.]]>
- </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 queue name to use to find resource allocations.
- @param queue Required. Cannot be null or empty.]]>
- </doc>
- </method>
- <method name="getReservationId" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reservation id to use to find a reservation.
- @return the reservation id of the reservation.]]>
- </doc>
- </method>
- <method name="setReservationId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservationId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the reservation id to use to find a reservation.
- @param reservationId Optional. String representation of
- {@code ReservationId} If provided, other fields will
- be ignored.]]>
- </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 start time to use to search for reservations.
- When this is set, reservations that start before this start
- time are ignored.
- @return the start time to use to search for reservations.]]>
- </doc>
- </method>
- <method name="setStartTime"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="startTime" type="long"/>
- <doc>
- <![CDATA[Set the start time to use to search for reservations.
- When this is set, reservations that start before this start
- time are ignored.
- @param startTime Optional. If provided, only reservations that
- end after the startTime will be selected. This defaults
- to 0 if an invalid number is used.]]>
- </doc>
- </method>
- <method name="getEndTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the end time to use to search for reservations.
- When this is set, reservations that start after this end
- time are ignored.
- @return the end time to use to search for reservations.]]>
- </doc>
- </method>
- <method name="setEndTime"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="endTime" type="long"/>
- <doc>
- <![CDATA[Set the end time to use to search for reservations.
- When this is set, reservations that start after this end
- time are ignored.
- @param endTime Optional. If provided, only reservations that
- start before endTime will be selected. This defaults
- to Long.MAX_VALUE if an invalid number is used.]]>
- </doc>
- </method>
- <method name="getIncludeResourceAllocations" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the boolean representing whether or not the user
- is requesting the full resource allocation.
- If this is true, the full resource allocation will
- be included in the response.
- @return the end time to use to search for reservations.]]>
- </doc>
- </method>
- <method name="setIncludeResourceAllocations"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="includeReservationAllocations" type="boolean"/>
- <doc>
- <![CDATA[Set the boolean representing whether or not the user
- is requesting the full resource allocation.
- If this is true, the full resource allocation will
- be included in the response.
- @param includeReservationAllocations Optional. Flag that
- determines whether the entire list of
- {@code ResourceAllocationRequest} will be returned.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationListRequest} captures the set of requirements the
- user has to list reservations.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
- <class name="ReservationListResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationListResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getReservationAllocationState" 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 ReservationAllocationState}, that corresponds
- to a reservation in the scheduler.
- @return the list of {@link ReservationAllocationState} which holds
- information of a particular reservation]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@link ReservationListResponse} captures the list of reservations that the
- user has queried.
- The resulting list of {@link ReservationAllocationState} contains a list of
- {@code ResourceAllocationRequest} representing the current state of the
- reservation resource allocations will be returned. This is subject to change
- in the event of re-planning a described by {@code ReservationDefinition}
- @see ReservationAllocationState]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ReservationListResponse -->
- <!-- 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"/>
- <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 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>
- <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 the reservation submission.
- @return reservation id that will be used to identify the reservation
- submission.]]>
- </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 corresponds to the reservation submission.
- @param reservationId reservation id that will be used to identify the
- reservation submission.]]>
- </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>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to a client on
- reservation submission.</p>
- <p>Currently, this is empty.</p>
- {@code ApplicationClientProtocol#submitReservation(
- ReservationSubmissionRequest)}]]>
- </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.ResourceLocalizationRequest -->
- <class name="ResourceLocalizationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceLocalizationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest"
- 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"/>
- <param name="localResources" type="java.util.Map"/>
- </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 to localize resources.
- @return <code>ContainerId</code> of the container to localize resources.]]>
- </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>
- <doc>
- <![CDATA[The request sent by the ApplicationMaster to ask for localizing resources.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse -->
- <class name="ResourceLocalizationResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceLocalizationResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[The response to the {@link ResourceLocalizationRequest}]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.ResourceLocalizationResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse -->
- <class name="RestartContainerResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RestartContainerResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[The response to a restart Container request.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RestartContainerResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse -->
- <class name="RollbackResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RollbackResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[Response to a Rollback request.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.RollbackResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
- <class name="SignalContainerRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SignalContainerRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest"
- 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"/>
- <param name="signalContainerCommand" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
- </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 to signal.
- @return <code>ContainerId</code> of the container to signal.]]>
- </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 to signal.]]>
- </doc>
- </method>
- <method name="getCommand" return="org.apache.hadoop.yarn.api.records.SignalContainerCommand"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>SignalContainerCommand</code> of the signal request.
- @return <code>SignalContainerCommand</code> of the signal request.]]>
- </doc>
- </method>
- <method name="setCommand"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="command" type="org.apache.hadoop.yarn.api.records.SignalContainerCommand"/>
- <doc>
- <![CDATA[Set the <code>SignalContainerCommand</code> of the signal request.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>The request sent by the client to the <code>ResourceManager</code>
- or by the <code>ApplicationMaster</code> to the <code>NodeManager</code>
- to signal a container.
- @see SignalContainerCommand </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
- <class name="SignalContainerResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SignalContainerResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[<p>The response sent by the <code>ResourceManager</code> to the client
- signalling a container.</p>
- <p>Currently it's empty.</p>
- @see ApplicationClientProtocol#signalToContainer(SignalContainerRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.SignalContainerResponse -->
- <!-- 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[Get the container token to be used for authorization during starting
- container.
- <p>
- Note: {@link NMToken} will be used for authenticating communication with
- {@code NodeManager}.
- @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
- @return map of containerId-to-exception]]>
- </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
- @return map of containerId-to-exception]]>
- </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 -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
- <class name="UpdateApplicationPriorityRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UpdateApplicationPriorityRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest"
- 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="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- </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>
- <method name="getApplicationPriority" 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 to be set.
-
- @return <code>Priority</code> of the application to be set.]]>
- </doc>
- </method>
- <method name="setApplicationPriority"
- 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 application.
-
- @param priority <code>Priority</code> of the application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request sent by the client to the <code>ResourceManager</code> to set or
- update the application priority.
- </p>
- <p>
- The request includes the {@link ApplicationId} of the application and
- {@link Priority} to be set for an application
- </p>
-
- @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
- <class name="UpdateApplicationPriorityResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UpdateApplicationPriorityResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse"
- 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"/>
- </method>
- <method name="getApplicationPriority" 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 to be set.
- @return Updated <code>Priority</code> of the application.]]>
- </doc>
- </method>
- <method name="setApplicationPriority"
- 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 application.
- @param priority <code>Priority</code> of the application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to the client on update
- the application priority.
- </p>
- <p>
- A response without exception means that the move has completed successfully.
- </p>
-
- @see ApplicationClientProtocol#updateApplicationPriority(UpdateApplicationPriorityRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationPriorityResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest -->
- <class name="UpdateApplicationTimeoutsRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UpdateApplicationTimeoutsRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest"
- 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="applicationTimeouts" type="java.util.Map"/>
- </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>
- <method name="getApplicationTimeouts" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
- in ISO8601 standard with format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
- @return all <code>ApplicationTimeouts</code> of the application.]]>
- </doc>
- </method>
- <method name="setApplicationTimeouts"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationTimeouts" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the <code>ApplicationTimeouts</code> for the application. Timeout value
- is absolute. Timeout value should meet ISO8601 format. Support ISO8601
- format is <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>. All pre-existing Map entries
- are cleared before adding the new Map.
- @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
- application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request sent by the client to the <code>ResourceManager</code> to set or
- update the application timeout.
- </p>
- <p>
- The request includes the {@link ApplicationId} of the application and timeout
- to be set for an application
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse -->
- <class name="UpdateApplicationTimeoutsResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UpdateApplicationTimeoutsResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getApplicationTimeouts" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
- in ISO8601 standard with format <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.
- @return all <code>ApplicationTimeouts</code> of the application.]]>
- </doc>
- </method>
- <method name="setApplicationTimeouts"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationTimeouts" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the <code>ApplicationTimeouts</code> for the application. Timeout value
- is absolute. Timeout value should meet ISO8601 format. Support ISO8601
- format is <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>. All pre-existing Map entries
- are cleared before adding the new Map.
- @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
- application]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response sent by the <code>ResourceManager</code> to the client on update
- application timeout.
- </p>
- <p>
- A response without exception means that the update has completed
- successfully.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UpdateApplicationTimeoutsResponse -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
- <class name="UseSharedCacheResourceRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UseSharedCacheResourceRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAppId" 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 resource to be used.
- @return <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="setAppId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="id" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- <doc>
- <![CDATA[Set the <code>ApplicationId</code> of the resource to be used.
- @param id <code>ApplicationId</code>]]>
- </doc>
- </method>
- <method name="getResourceKey" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>key</code> of the resource to be used.
- @return <code>key</code>]]>
- </doc>
- </method>
- <method name="setResourceKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="key" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>key</code> of the resource to be used.
- @param key unique identifier for the resource]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The request from clients to the <code>SharedCacheManager</code> that claims a
- resource in the shared cache.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceRequest -->
- <!-- start class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
- <class name="UseSharedCacheResourceResponse" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UseSharedCacheResourceResponse"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getPath" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Path</code> corresponding to the requested resource in the
- shared cache.
- @return String A <code>Path</code> if the resource exists in the shared
- cache, <code>null</code> otherwise]]>
- </doc>
- </method>
- <method name="setPath"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="p" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>Path</code> corresponding to a resource in the shared cache.
- @param p A <code>Path</code> corresponding to a resource in the shared
- cache]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The response from the SharedCacheManager to the client that indicates whether
- a requested resource exists in the cache.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.protocolrecords.UseSharedCacheResourceResponse -->
- </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="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- 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="attemptId" type="int"/>
- </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 <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>
- <method name="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appAttemptIdStr" type="java.lang.String"/>
- </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="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationAttemptReport"
- 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"/>
- <param name="host" type="java.lang.String"/>
- <param name="rpcPort" type="int"/>
- <param name="url" type="java.lang.String"/>
- <param name="oUrl" type="java.lang.String"/>
- <param name="diagnostics" type="java.lang.String"/>
- <param name="state" type="org.apache.hadoop.yarn.api.records.YarnApplicationAttemptState"/>
- <param name="amContainerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- </method>
- <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>
- <method name="getStartTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </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>
- <doc>
- <![CDATA[{@code ApplicationAttemptReport} is a report of an application attempt.
- <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>]]>
- </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="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="clusterTimestamp" type="long"/>
- <param name="id" type="int"/>
- </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 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="fromString" return="org.apache.hadoop.yarn.api.records.ApplicationId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appIdStr" type="java.lang.String"/>
- </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="getSubmitTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getLaunchTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </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:
- <ul>
- <li>the requester is the owner of the ApplicationMaster</li>
- <li>the application master is an unmanaged ApplicationMaster</li>
- <li>the application master is in ACCEPTED state</li>
- </ul>
- Else this method returns NULL.
-
- @return the AM to RM token if available.]]>
- </doc>
- </method>
- <method name="getLogAggregationStatus" return="org.apache.hadoop.yarn.api.records.LogAggregationStatus"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get log aggregation status for the application
- @return Application's log aggregation status]]>
- </doc>
- </method>
- <method name="isUnmanagedApp" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[@return true if the AM is not managed by the RM]]>
- </doc>
- </method>
- <method name="setUnmanagedApp"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="unmanagedApplication" type="boolean"/>
- <doc>
- <![CDATA[@param unmanagedApplication true if RM should not manage the AM]]>
- </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 priority of the application
- @return Application's priority]]>
- </doc>
- </method>
- <method name="getAppNodeLabelExpression" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default Node Label expression for all the application's containers
- @return Application's NodeLabelExpression]]>
- </doc>
- </method>
- <method name="setAppNodeLabelExpression"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appNodeLabelExpression" type="java.lang.String"/>
- </method>
- <method name="getAmNodeLabelExpression" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the default Node Label expression for all the application's containers
- @return Application's NodeLabelExpression]]>
- </doc>
- </method>
- <method name="setAmNodeLabelExpression"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="amNodeLabelExpression" type="java.lang.String"/>
- </method>
- <method name="getApplicationTimeouts" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <doc>
- <![CDATA[{@code ApplicationReport} is a report of an application.
- <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>
- @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>
- <method name="getQueueUsagePercentage" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the percentage of resources of the queue that the app is using.
- @return the percentage of resources of the queue that the app is using.]]>
- </doc>
- </method>
- <method name="getClusterUsagePercentage" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the percentage of resources of the cluster that the app is using.
- @return the percentage of resources of the cluster that the app is using.]]>
- </doc>
- </method>
- <method name="getPreemptedMemorySeconds" 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 preempted(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="getPreemptedVcoreSeconds" 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 preempted that the application has
- allocated times the number of seconds the application has been running.
- @return the aggregated number of vcore seconds]]>
- </doc>
- </method>
- <method name="getResourceSecondsMap" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the aggregated number of resources that the application has
- allocated times the number of seconds the application has been running.
- @return map containing the resource name and aggregated resource-seconds]]>
- </doc>
- </method>
- <method name="getPreemptedResourceSecondsMap" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the aggregated number of resources preempted that the application has
- allocated times the number of seconds the application has been running.
- @return map containing the resource name and aggregated preempted
- resource-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>
- For managed AM, 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>
- <p>
- For unmanaged AM, if the flag is true, RM allows re-register and returns
- the running containers in the same attempt back to the UAM for HA.
- </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#RM_APPLICATION_MAX_TAGS} are allowed
- per application. Each tag can be at most
- {@link YarnConfiguration#RM_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="See {@link #getAMContainerResourceRequests()}">
- <doc>
- <![CDATA[Get the ResourceRequest of the 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 ignored.
- @return ResourceRequest of the AM container
- @deprecated See {@link #getAMContainerResourceRequests()}]]>
- </doc>
- </method>
- <method name="setAMContainerResourceRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="See {@link #setAMContainerResourceRequests(List)}">
- <param name="request" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- <doc>
- <![CDATA[Set ResourceRequest of the AM container
- @param request of the AM container
- @deprecated See {@link #setAMContainerResourceRequests(List)}]]>
- </doc>
- </method>
- <method name="getAMContainerResourceRequests" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the ResourceRequests of the AM container.
- If this is not null, scheduler will use this to acquire resource for AM
- container.
- If this is null, scheduler will use the ResourceRequest as determined by
- <em>getAMContainerResourceRequest</em> and its behavior.
- Number of containers and Priority will be ignored.
- @return List of ResourceRequests of the AM container]]>
- </doc>
- </method>
- <method name="setAMContainerResourceRequests"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="requests" type="java.util.List"/>
- <doc>
- <![CDATA[Set ResourceRequests of the AM container.
- @param requests of the 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>
- <method name="getApplicationTimeouts" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>ApplicationTimeouts</code> of the application. Timeout value is
- in seconds.
- @return all <code>ApplicationTimeouts</code> of the application.]]>
- </doc>
- </method>
- <method name="setApplicationTimeouts"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="applicationTimeouts" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the <code>ApplicationTimeouts</code> for the application in seconds.
- All pre-existing Map entries are cleared before adding the new Map.
- <p>
- <b>Note:</b> If application timeout value is less than or equal to zero
- then application submission will throw an exception.
- </p>
- @param applicationTimeouts <code>ApplicationTimeouts</code>s for the
- application]]>
- </doc>
- </method>
- <method name="getApplicationSchedulingPropertiesMap" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get application scheduling environment variables stored as a key value
- pair map for application.
- @return placement envs for application.]]>
- </doc>
- </method>
- <method name="setApplicationSchedulingPropertiesMap"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="schedulingEnvMap" type="java.util.Map"/>
- <doc>
- <![CDATA[Set the scheduling envs for the application.
- @param schedulingEnvMap
- A map of env's for the application scheduling preferences.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ApplicationSubmissionContext} represents all of the
- information needed by the {@code ResourceManager} to launch
- the {@code ApplicationMaster} for an application.
- <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
- {@literal >} 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>
-
- @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.ApplicationTimeout -->
- <class name="ApplicationTimeout" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationTimeout"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ApplicationTimeout"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"/>
- <param name="expiryTime" type="java.lang.String"/>
- <param name="remainingTime" type="long"/>
- </method>
- <method name="getTimeoutType" return="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the application timeout type.
- @return timeoutType of an application timeout.]]>
- </doc>
- </method>
- <method name="setTimeoutType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timeoutType" type="org.apache.hadoop.yarn.api.records.ApplicationTimeoutType"/>
- <doc>
- <![CDATA[Set the application timeout type.
- @param timeoutType of an application timeout.]]>
- </doc>
- </method>
- <method name="getExpiryTime" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>expiryTime</code> for given timeout type.
- @return expiryTime in ISO8601 standard with format
- <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.]]>
- </doc>
- </method>
- <method name="setExpiryTime"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="expiryTime" type="java.lang.String"/>
- <doc>
- <![CDATA[Set <code>expiryTime</code> for given timeout type.
- @param expiryTime in ISO8601 standard with format
- <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b>.]]>
- </doc>
- </method>
- <method name="getRemainingTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>Remaining Time</code> of an application for given timeout type.
- @return Remaining Time in seconds.]]>
- </doc>
- </method>
- <method name="setRemainingTime"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="remainingTime" type="long"/>
- <doc>
- <![CDATA[Set <code>Remaining Time</code> of an application for given timeout type.
- @param remainingTime in seconds.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ApplicationTimeout} is a report for configured application timeouts.
- It includes details such as:
- <ul>
- <li>{@link ApplicationTimeoutType} of the timeout type.</li>
- <li>Expiry time in ISO8601 standard with format
- <b>yyyy-MM-dd'T'HH:mm:ss.SSSZ</b> or "UNLIMITED".</li>
- <li>Remaining time in seconds.</li>
- </ul>
- The possible values for {ExpiryTime, RemainingTimeInSeconds} are
- <ul>
- <li>{UNLIMITED,-1} : Timeout is not configured for given timeout type
- (LIFETIME).</li>
- <li>{ISO8601 date string, 0} : Timeout is configured and application has
- completed.</li>
- <li>{ISO8601 date string, greater than zero} : Timeout is configured and
- application is RUNNING. Application will be timed out after configured
- value.</li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationTimeout -->
- <!-- start class org.apache.hadoop.yarn.api.records.ApplicationTimeoutType -->
- <class name="ApplicationTimeoutType" 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.ApplicationTimeoutType[]"
- 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.ApplicationTimeoutType"
- 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 timeout type.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ApplicationTimeoutType -->
- <!-- start class org.apache.hadoop.yarn.api.records.CollectorInfo -->
- <class name="CollectorInfo" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="CollectorInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="collectorAddr" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.CollectorInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="collectorAddr" type="java.lang.String"/>
- <param name="token" type="org.apache.hadoop.yarn.api.records.Token"/>
- </method>
- <method name="getCollectorAddr" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCollectorAddr"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="addr" type="java.lang.String"/>
- </method>
- <method name="getCollectorToken" 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 delegation token for app collector which AM will use to publish
- entities.
- @return the delegation token for app collector.]]>
- </doc>
- </method>
- <method name="setCollectorToken"
- 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>
- <field name="DEFAULT_TIMESTAMP_VALUE" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Collector info containing collector address and collector token passed from
- RM to AM in Allocate Response.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.CollectorInfo -->
- <!-- 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="getExposedPorts" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the exposed ports of the node on which the container is allocated.
- @return exposed ports 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>
- <method name="getAllocationRequestId" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the optional <em>ID</em> corresponding to the original {@code
- ResourceRequest{@link #getAllocationRequestId()}}s which is satisfied by
- this allocated {@code Container}.
- <p>
- The scheduler may return multiple {@code AllocateResponse}s corresponding
- to the same ID as and when scheduler allocates {@code Container}s.
- <b>Applications</b> can continue to completely ignore the returned ID in
- the response and use the allocation for any of their outstanding requests.
- <p>
- @return the <em>ID</em> corresponding to the original allocation request
- which is satisfied by this allocation.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code Container} represents an allocated resource in the cluster.
- <p>
- The {@code ResourceManager} is the sole authority to allocate any
- {@code Container} to applications. The allocated {@code Container}
- is always on a single node and has a unique {@link ContainerId}. It has
- a specific amount of {@link Resource} allocated.
- <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>
-
- Typically, an {@code ApplicationMaster} receives the {@code Container}
- from the {@code ResourceManager} during resource-negotiation and then
- talks to the {@code NodeManager} to start/stop containers.
-
- @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>
- <field name="KILLED_BY_CONTAINER_SCHEDULER" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container was terminated by the ContainerScheduler to make room
- for another container...]]>
- </doc>
- </field>
- <field name="KILLED_FOR_EXCESS_LOGS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container was terminated for generating excess log data.]]>
- </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="newContainerId" 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="appAttemptId" type="org.apache.hadoop.yarn.api.records.ApplicationAttemptId"/>
- <param name="containerId" type="long"/>
- </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 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="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"/>
- <param name="containerRetryContext" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"/>
- </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="getTokensConf" return="java.nio.ByteBuffer"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the configuration used by RM to renew tokens.
- @return The configuration used by RM to renew the tokens.]]>
- </doc>
- </method>
- <method name="setTokensConf"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="tokensConf" type="java.nio.ByteBuffer"/>
- <doc>
- <![CDATA[Set the configuration used by RM to renew the tokens.
- @param tokensConf The configuration used by RM to renew the 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>
- <method name="getContainerRetryContext" return="org.apache.hadoop.yarn.api.records.ContainerRetryContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerRetryContext</code> to relaunch container.
- @return <code>ContainerRetryContext</code> to relaunch container.]]>
- </doc>
- </method>
- <method name="setContainerRetryContext"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerRetryContext" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"/>
- <doc>
- <![CDATA[Set the <code>ContainerRetryContext</code> to relaunch container.
- @param containerRetryContext <code>ContainerRetryContext</code> to
- relaunch container.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ContainerLaunchContext} represents all of the information
- needed by the {@code NodeManager} to launch a container.
- <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>
- <li>Retry strategy when container exits with failure.</li>
- </ul>
-
- @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>
- <method name="getExposedPorts" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get exposed ports of the container.
-
- @return the node exposed ports of the container]]>
- </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 Node Http address of the container.
- @return the node http address of the container]]>
- </doc>
- </method>
- <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the execution type of the container.
- @return the execution type of the container]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ContainerReport} is a report of an container.
- <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>
- <li>nodeHttpAddress</li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerReport -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerRetryContext -->
- <class name="ContainerRetryContext" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerRetryContext"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getRetryPolicy" return="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setRetryPolicy"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="retryPolicy" type="org.apache.hadoop.yarn.api.records.ContainerRetryPolicy"/>
- </method>
- <method name="getErrorCodes" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setErrorCodes"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="errorCodes" type="java.util.Set"/>
- </method>
- <method name="getMaxRetries" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setMaxRetries"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="maxRetries" type="int"/>
- </method>
- <method name="getRetryInterval" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setRetryInterval"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="retryInterval" type="int"/>
- </method>
- <method name="getFailuresValidityInterval" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setFailuresValidityInterval"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="failuresValidityInterval" type="long"/>
- </method>
- <field name="RETRY_FOREVER" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RETRY_INVALID" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NEVER_RETRY_CONTEXT" type="org.apache.hadoop.yarn.api.records.ContainerRetryContext"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[{@code ContainerRetryContext} indicates how container retry after it fails
- to run.
- <p>
- It provides details such as:
- <ul>
- <li>
- {@link ContainerRetryPolicy} :
- - NEVER_RETRY(DEFAULT value): no matter what error code is when container
- fails to run, just do not retry.
- - RETRY_ON_ALL_ERRORS: no matter what error code is, when container fails
- to run, just retry.
- - RETRY_ON_SPECIFIC_ERROR_CODES: when container fails to run, do retry if
- the error code is one of <em>errorCodes</em>, otherwise do not retry.
- Note: if error code is 137(SIGKILL) or 143(SIGTERM), it will not retry
- because it is usually killed on purpose.
- </li>
- <li>
- <em>maxRetries</em> specifies how many times to retry if need to retry.
- If the value is -1, it means retry forever.
- </li>
- <li><em>retryInterval</em> specifies delaying some time before relaunch
- container, the unit is millisecond.</li>
- <li>
- <em>failuresValidityInterval</em>: default value is -1.
- When failuresValidityInterval in milliseconds is set to {@literal >} 0,
- the failure number will not take failures which happen out of the
- failuresValidityInterval into failure count. If failure count
- reaches to <em>maxRetries</em>, the container will be failed.
- </li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerRetryContext -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerRetryPolicy -->
- <class name="ContainerRetryPolicy" 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.ContainerRetryPolicy[]"
- 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.ContainerRetryPolicy"
- 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>Retry policy for relaunching a <code>Container</code>.</p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerRetryPolicy -->
- <!-- 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="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ExecutionType</code> of the container.
- @return <code>ExecutionType</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>
- <method name="getCapability" 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 the <code>Resource</code> allocated to the container.
- @return <code>Resource</code> allocated to the container]]>
- </doc>
- </method>
- <method name="getIPs" return="java.util.List"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get all the IP addresses with which the container run.
- @return The IP address where the container runs.]]>
- </doc>
- </method>
- <method name="getHost" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the hostname where the container runs.
- @return The hostname where the container runs.]]>
- </doc>
- </method>
- <method name="getExposedPorts" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get exposed ports of the container.
- @return List of exposed ports]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ContainerStatus} represents the current status of a
- {@code Container}.
- <p>
- It provides details such as:
- <ul>
- <li>{@code ContainerId} of the container.</li>
- <li>{@code ExecutionType} of the container.</li>
- <li>{@code ContainerState} of the container.</li>
- <li><em>Exit status</em> of a completed container.</li>
- <li><em>Diagnostic</em> message for a failed container.</li>
- <li>{@link Resource} allocated to the container.</li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerStatus -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerSubState -->
- <class name="ContainerSubState" 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.ContainerSubState[]"
- 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.ContainerSubState"
- 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[Container Sub-State.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerSubState -->
- <!-- start class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
- <class name="ContainerUpdateType" 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.ContainerUpdateType[]"
- 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.ContainerUpdateType"
- 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[Encodes the type of Container Update.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ContainerUpdateType -->
- <!-- start class org.apache.hadoop.yarn.api.records.ExecutionType -->
- <class name="ExecutionType" 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.ExecutionType[]"
- 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.ExecutionType"
- 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[Container property encoding execution semantics.
- <p>
- The execution types are the following:
- <ul>
- <li>{@link #GUARANTEED} - this container is guaranteed to start its
- execution, once the corresponding start container request is received by
- an NM.
- <li>{@link #OPPORTUNISTIC} - the execution of this container may not start
- immediately at the NM that receives the corresponding start container
- request (depending on the NM's available resources). Moreover, it may be
- preempted if it blocks a GUARANTEED container from being executed.
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ExecutionType -->
- <!-- start class org.apache.hadoop.yarn.api.records.ExecutionTypeRequest -->
- <class name="ExecutionTypeRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ExecutionTypeRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
- 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.records.ExecutionTypeRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
- <param name="ensureExecutionType" type="boolean"/>
- </method>
- <method name="setExecutionType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="execType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
- <doc>
- <![CDATA[Set the <code>ExecutionType</code> of the requested container.
- @param execType
- ExecutionType of the requested container]]>
- </doc>
- </method>
- <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <code>ExecutionType</code>.
- @return <code>ExecutionType</code>.]]>
- </doc>
- </method>
- <method name="setEnforceExecutionType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="enforceExecutionType" type="boolean"/>
- <doc>
- <![CDATA[Set to true to explicitly ask that the Scheduling Authority return
- Containers of exactly the Execution Type requested.
- @param enforceExecutionType whether ExecutionType request should be
- strictly honored.]]>
- </doc>
- </method>
- <method name="getEnforceExecutionType" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get whether Scheduling Authority should return Containers of exactly the
- Execution Type requested for this <code>ResourceRequest</code>.
- Defaults to false.
- @return whether ExecutionType request should be strictly honored]]>
- </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>
- <doc>
- <![CDATA[An object of this class represents a specification of the execution
- guarantee of the Containers associated with a ResourceRequest. It consists
- of an <code>ExecutionType</code> as well as flag that explicitly asks the
- configuredScheduler to return Containers of exactly the Execution Type
- requested.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ExecutionTypeRequest -->
- <!-- 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.LocalizationState -->
- <class name="LocalizationState" 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.LocalizationState[]"
- 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.LocalizationState"
- 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[State of localization.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LocalizationState -->
- <!-- start class org.apache.hadoop.yarn.api.records.LocalizationStatus -->
- <class name="LocalizationStatus" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="LocalizationStatus"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalizationStatus"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceKey" type="java.lang.String"/>
- <param name="localizationState" type="org.apache.hadoop.yarn.api.records.LocalizationState"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.LocalizationStatus"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceKey" type="java.lang.String"/>
- <param name="localizationState" type="org.apache.hadoop.yarn.api.records.LocalizationState"/>
- <param name="diagnostics" type="java.lang.String"/>
- </method>
- <method name="getResourceKey" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the resource key.
- @return resource key.]]>
- </doc>
- </method>
- <method name="getLocalizationState" return="org.apache.hadoop.yarn.api.records.LocalizationState"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the localization sate.
- @return localization state.]]>
- </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 diagnostics.
- @return diagnostics.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Represents the localization status of a resource.
- The status of the localization includes:
- <ul>
- <li>resource key</li>
- <li>{@link LocalizationState} of the resource</li>
- </ul>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.LocalizationStatus -->
- <!-- 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"/>
- <param name="pattern" type="java.lang.String"/>
- <param name="shouldBeUploadedToSharedCache" type="boolean"/>
- </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="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="shouldBeUploadedToSharedCache" type="boolean"/>
- </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>
- <method name="getShouldBeUploadedToSharedCache" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[NM uses it to decide whether if it is necessary to upload the resource to
- the shared cache
- @return true if it is necessary to upload the resource
- to the shared cache,
- false otherwise]]>
- </doc>
- </method>
- <method name="setShouldBeUploadedToSharedCache"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="shouldBeUploadedToSharedCache" type="boolean"/>
- <doc>
- <![CDATA[Inform NM whether upload to SCM is needed.
- @param shouldBeUploadedToSharedCache <em>shouldBeUploadedToSharedCache</em>
- of this request]]>
- </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[{@code LocalResourceType} specifies the <em>type</em>
- of a resource localized by the {@code NodeManager}.
- <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}.
- </li>
- </ul>
- @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[{@code LocalResourceVisibility} specifies the <em>visibility</em>
- of a resource localized by the {@code NodeManager}.
- <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>
-
- @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="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"/>
- <param name="rolledLogsIncludePattern" type="java.lang.String"/>
- <param name="rolledLogsExcludePattern" type="java.lang.String"/>
- </method>
- <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"/>
- <param name="rolledLogsIncludePattern" type="java.lang.String"/>
- <param name="rolledLogsExcludePattern" type="java.lang.String"/>
- <param name="policyClassName" type="java.lang.String"/>
- <param name="policyParameters" 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. This includePattern only takes affect
- on logs that exist at the time of application finish.
- @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. This includePattern only takes affect
- on logs that exist at the time of application finish.
- @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. This excludePattern only takes affect
- on logs that exist at the time of application finish.
- @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. This excludePattern only takes affect
- on logs that exist at the time of application finish.
- @param excludePattern]]>
- </doc>
- </method>
- <method name="getRolledLogsIncludePattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get include pattern in a rolling fashion.
-
- @return include pattern]]>
- </doc>
- </method>
- <method name="setRolledLogsIncludePattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rolledLogsIncludePattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set include pattern in a rolling fashion.
-
- @param rolledLogsIncludePattern]]>
- </doc>
- </method>
- <method name="getRolledLogsExcludePattern" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get exclude pattern for aggregation in a rolling fashion.
-
- @return exclude pattern]]>
- </doc>
- </method>
- <method name="setRolledLogsExcludePattern"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="rolledLogsExcludePattern" type="java.lang.String"/>
- <doc>
- <![CDATA[Set exclude pattern for in a rolling fashion.
-
- @param rolledLogsExcludePattern]]>
- </doc>
- </method>
- <method name="getLogAggregationPolicyClassName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the log aggregation policy class.
- @return log aggregation policy class]]>
- </doc>
- </method>
- <method name="setLogAggregationPolicyClassName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="className" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the log aggregation policy class.
- @param className]]>
- </doc>
- </method>
- <method name="getLogAggregationPolicyParameters" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the log aggregation policy parameters.
- @return log aggregation policy parameters]]>
- </doc>
- </method>
- <method name="setLogAggregationPolicyParameters"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="parameters" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the log aggregation policy parameters.
- There is no schema defined for the parameters string.
- It is up to the log aggregation policy class to decide how to parse
- the parameters string.
- @param parameters]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code LogAggregationContext} represents all of the
- information needed by the {@code NodeManager} to handle
- the logs for an application.
- <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 when the application finishes.
- </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 when application finishes. If the log file
- name matches both the include and the exclude pattern, this file
- will be excluded eventually.
- </li>
- <li>
- rolledLogsIncludePattern. It uses Java Regex to filter the log files
- which match the defined include pattern and those log files
- will be aggregated in a rolling fashion.
- </li>
- <li>
- rolledLogsExcludePattern. It uses Java Regex to filter the log files
- which match the defined exclude pattern and those log files
- will not be aggregated in a rolling fashion. If the log file
- name matches both the include and the exclude pattern, this file
- will be excluded eventually.
- </li>
- <li>
- policyClassName. The policy class name that implements
- ContainerLogAggregationPolicy. At runtime, nodemanager will the policy
- if a given container's log should be aggregated based on the
- ContainerType and other runtime state such as exit code by calling
- ContainerLogAggregationPolicy#shouldDoLogAggregation.
- This is useful when the app only wants to aggregate logs of a subset of
- containers. Here are the available policies. Please make sure to specify
- the canonical name by prefixing org.apache.hadoop.yarn.server.
- nodemanager.containermanager.logaggregation.
- to the class simple name below.
- NoneContainerLogAggregationPolicy: skip aggregation for all containers.
- AllContainerLogAggregationPolicy: aggregate all containers.
- AMOrFailedContainerLogAggregationPolicy: aggregate application master
- or failed containers.
- FailedOrKilledContainerLogAggregationPolicy: aggregate failed or killed
- containers
- FailedContainerLogAggregationPolicy: aggregate failed containers
- AMOnlyLogAggregationPolicy: aggregate application master containers
- SampleContainerLogAggregationPolicy: sample logs of successful worker
- containers, in addition to application master and failed/killed
- containers.
- LimitSizeContainerLogAggregationPolicy: skip aggregation for killed
- containers whose log size exceeds the limit of container log size.
- If it isn't specified, it will use the cluster-wide default policy
- defined by configuration yarn.nodemanager.log-aggregation.policy.class.
- The default value of yarn.nodemanager.log-aggregation.policy.class is
- AllContainerLogAggregationPolicy.
- </li>
- <li>
- policyParameters. The parameters passed to the policy class via
- ContainerLogAggregationPolicy#parseParameters during the policy object
- initialization. This is optional. Some policy class might use parameters
- to adjust its settings. It is up to policy class to define the scheme of
- parameters.
- For example, SampleContainerLogAggregationPolicy supports the format of
- "SR:0.5,MIN:50", which means sample rate of 50% beyond the first 50
- successful worker containers.
- </li>
- </ul>
- @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.NodeAttribute -->
- <class name="NodeAttribute" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NodeAttribute"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttribute"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
- <param name="attributeValue" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttribute"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributePrefix" type="java.lang.String"/>
- <param name="attributeName" type="java.lang.String"/>
- <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
- <param name="attributeValue" type="java.lang.String"/>
- </method>
- <method name="getAttributeKey" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAttributeKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeKey" type="org.apache.hadoop.yarn.api.records.NodeAttributeKey"/>
- </method>
- <method name="getAttributeValue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAttributeValue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeValue" type="java.lang.String"/>
- </method>
- <method name="getAttributeType" return="org.apache.hadoop.yarn.api.records.NodeAttributeType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAttributeType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
- </method>
- <field name="PREFIX_DISTRIBUTED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PREFIX_CENTRALIZED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p>
- Node Attribute is a kind of a label which represents one of the
- attribute/feature of a Node. Its different from node partition label as
- resource guarantees across the queues will not be maintained for these type
- of labels.
- </p>
- <p>
- A given Node can be mapped with any kind of attribute, few examples are
- HAS_SSD=true, JAVA_VERSION=JDK1.8, OS_TYPE=WINDOWS.
- </p>
- <p>
- Its not compulsory for all the attributes to have value, empty string is the
- default value of the <code>NodeAttributeType.STRING</code>
- </p>
- <p>
- Node Attribute Prefix is used as namespace to segregate the attributes.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeAttribute -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeInfo -->
- <class name="NodeAttributeInfo" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NodeAttributeInfo"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeAttribute" type="org.apache.hadoop.yarn.api.records.NodeAttribute"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeInfo"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeAttributeKey" type="org.apache.hadoop.yarn.api.records.NodeAttributeKey"/>
- <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
- </method>
- <method name="getAttributeKey" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAttributeKey"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeKey" type="org.apache.hadoop.yarn.api.records.NodeAttributeKey"/>
- </method>
- <method name="getAttributeType" return="org.apache.hadoop.yarn.api.records.NodeAttributeType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAttributeType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeType" type="org.apache.hadoop.yarn.api.records.NodeAttributeType"/>
- </method>
- <doc>
- <![CDATA[<p>
- Node Attribute Info describes a NodeAttribute.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeInfo -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeKey -->
- <class name="NodeAttributeKey" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NodeAttributeKey"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeAttributeKey"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributePrefix" type="java.lang.String"/>
- <param name="attributeName" type="java.lang.String"/>
- </method>
- <method name="getAttributePrefix" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAttributePrefix"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributePrefix" type="java.lang.String"/>
- </method>
- <method name="getAttributeName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAttributeName"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeName" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[<p>
- Node AttributeKey uniquely identifies a given Node Attribute. Node Attribute
- is identified based on attribute prefix and name.
- </p>
- <p>
- Node Attribute Prefix is used as namespace to segregate the attributes.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeKey -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeOpCode -->
- <class name="NodeAttributeOpCode" 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.NodeAttributeOpCode[]"
- 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.NodeAttributeOpCode"
- 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 node attribute op codes.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeOpCode -->
- <!-- start class org.apache.hadoop.yarn.api.records.NodeAttributeType -->
- <class name="NodeAttributeType" 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.NodeAttributeType[]"
- 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.NodeAttributeType"
- 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>
- Type of a <code>node Attribute</code>.
- </p>
- Based on this attribute expressions and values will be evaluated.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeAttributeType -->
- <!-- 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="newInstance" return="org.apache.hadoop.yarn.api.records.NodeId"
- 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"/>
- </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>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="fromString" return="org.apache.hadoop.yarn.api.records.NodeId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeIdStr" type="java.lang.String"/>
- </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.NodeLabel -->
- <class name="NodeLabel" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="NodeLabel"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getName" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isExclusive" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- 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.NodeLabel"/>
- </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>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="DEFAULT_NODE_LABEL_PARTITION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default node label partition used for displaying.]]>
- </doc>
- </field>
- <field name="NODE_LABEL_EXPRESSION_NOT_SET" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Node Label expression not set .]]>
- </doc>
- </field>
- <field name="DEFAULT_NODE_LABEL_EXCLUSIVITY" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[By default, node label is exclusive or not]]>
- </doc>
- </field>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeLabel -->
- <!-- 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>
- <method name="getAggregatedContainersUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get containers aggregated resource utilization in a node.
- @return containers resource utilization.]]>
- </doc>
- </method>
- <method name="getNodeUtilization" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get node resource utilization.
- @return node resource utilization.]]>
- </doc>
- </method>
- <method name="getDecommissioningTimeout" return="java.lang.Integer"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Optional decommissioning timeout in seconds (null indicates absent
- timeout).
- @return the decommissioning timeout in second.]]>
- </doc>
- </method>
- <method name="setDecommissioningTimeout"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="decommissioningTimeout" type="java.lang.Integer"/>
- <doc>
- <![CDATA[Set the decommissioning timeout in seconds (null indicates absent timeout).]]>
- </doc>
- </method>
- <method name="getNodeUpdateType" return="org.apache.hadoop.yarn.api.records.NodeUpdateType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Optional node update type (null indicates absent update type).
- @return the node update.]]>
- </doc>
- </method>
- <method name="setNodeUpdateType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeUpdateType" type="org.apache.hadoop.yarn.api.records.NodeUpdateType"/>
- <doc>
- <![CDATA[Set the node update type (null indicates absent node update type).]]>
- </doc>
- </method>
- <method name="setNodeAttributes"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeAttributes" type="java.util.Set"/>
- <doc>
- <![CDATA[Set the node attributes of node.
- @param nodeAttributes set of node attributes.]]>
- </doc>
- </method>
- <method name="getNodeAttributes" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get node attributes of node.
- @return the set of node attributes.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code NodeReport} is a summary of runtime information of a node
- in the cluster.
- <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>
- @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>
- <method name="isInactiveState" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="isActiveState" 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.NodeToAttributeValue -->
- <class name="NodeToAttributeValue" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="NodeToAttributeValue"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.NodeToAttributeValue"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostname" type="java.lang.String"/>
- <param name="attributeValue" type="java.lang.String"/>
- </method>
- <method name="getAttributeValue" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAttributeValue"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="attributeValue" type="java.lang.String"/>
- </method>
- <method name="getHostname" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setHostname"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hostname" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[<p>
- Mapping of Attribute Value to a Node.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.NodeToAttributeValue -->
- <!-- 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[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} (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>
- 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>
- 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>
- Each preemption message reflects the RM's current understanding of the
- cluster state, so a request to return <em>N</em> 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>
- 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.]]>
- </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[{@code QueueACL} enumerates the various ACLs for queues.
- <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>
-
- @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>
- <method name="getQueueStatistics" return="org.apache.hadoop.yarn.api.records.QueueStatistics"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>queue stats</code> for the queue
- @return <code>queue stats</code> of the queue]]>
- </doc>
- </method>
- <method name="setQueueStatistics"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queueStatistics" type="org.apache.hadoop.yarn.api.records.QueueStatistics"/>
- <doc>
- <![CDATA[Set the queue statistics for the queue
-
- @param queueStatistics
- the queue statistics]]>
- </doc>
- </method>
- <method name="getPreemptionDisabled" return="java.lang.Boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <em>preemption status</em> of the queue.
- @return if property is not in proto, return null;
- otherwise, return <em>preemption status</em> of the queue]]>
- </doc>
- </method>
- <method name="getQueueConfigurations" return="java.util.Map"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the per-node-label queue configurations of the queue.
- @return the per-node-label queue configurations of the queue.]]>
- </doc>
- </method>
- <method name="getIntraQueuePreemptionDisabled" return="java.lang.Boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the intra-queue preemption status of the queue.
- @return if property is not in proto, return null;
- otherwise, return intra-queue preemption status of the queue]]>
- </doc>
- </method>
- <doc>
- <![CDATA[QueueInfo is a report of the runtime information of the queue.
- <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>
- <li>{@link QueueConfigurations} of the queue.</li>
- </ul>
- @see QueueState
- @see QueueConfigurations
- @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[State of a Queue.
- <p>
- A queue is in one of:
- <ul>
- <li>{@link #RUNNING} - normal state.</li>
- <li>{@link #STOPPED} - not accepting new application submissions.</li>
- <li>
- {@link #DRAINING} - not accepting new application submissions
- and waiting for applications finish.
- </li>
- </ul>
-
- @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.QueueStatistics -->
- <class name="QueueStatistics" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="QueueStatistics"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getNumAppsSubmitted" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of apps submitted
-
- @return the number of apps submitted]]>
- </doc>
- </method>
- <method name="setNumAppsSubmitted"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numAppsSubmitted" type="long"/>
- <doc>
- <![CDATA[Set the number of apps submitted
-
- @param numAppsSubmitted
- the number of apps submitted]]>
- </doc>
- </method>
- <method name="getNumAppsRunning" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of running apps
-
- @return the number of running apps]]>
- </doc>
- </method>
- <method name="setNumAppsRunning"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numAppsRunning" type="long"/>
- <doc>
- <![CDATA[Set the number of running apps
-
- @param numAppsRunning
- the number of running apps]]>
- </doc>
- </method>
- <method name="getNumAppsPending" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of pending apps
-
- @return the number of pending apps]]>
- </doc>
- </method>
- <method name="setNumAppsPending"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numAppsPending" type="long"/>
- <doc>
- <![CDATA[Set the number of pending apps
-
- @param numAppsPending
- the number of pending apps]]>
- </doc>
- </method>
- <method name="getNumAppsCompleted" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of completed apps
-
- @return the number of completed apps]]>
- </doc>
- </method>
- <method name="setNumAppsCompleted"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numAppsCompleted" type="long"/>
- <doc>
- <![CDATA[Set the number of completed apps
-
- @param numAppsCompleted
- the number of completed apps]]>
- </doc>
- </method>
- <method name="getNumAppsKilled" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of killed apps
-
- @return the number of killed apps]]>
- </doc>
- </method>
- <method name="setNumAppsKilled"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numAppsKilled" type="long"/>
- <doc>
- <![CDATA[Set the number of killed apps
-
- @param numAppsKilled
- the number of killed apps]]>
- </doc>
- </method>
- <method name="getNumAppsFailed" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of failed apps
-
- @return the number of failed apps]]>
- </doc>
- </method>
- <method name="setNumAppsFailed"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numAppsFailed" type="long"/>
- <doc>
- <![CDATA[Set the number of failed apps
-
- @param numAppsFailed
- the number of failed apps]]>
- </doc>
- </method>
- <method name="getNumActiveUsers" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of active users
-
- @return the number of active users]]>
- </doc>
- </method>
- <method name="setNumActiveUsers"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numActiveUsers" type="long"/>
- <doc>
- <![CDATA[Set the number of active users
-
- @param numActiveUsers
- the number of active users]]>
- </doc>
- </method>
- <method name="getAvailableMemoryMB" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the available memory in MB
-
- @return the available memory]]>
- </doc>
- </method>
- <method name="setAvailableMemoryMB"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="availableMemoryMB" type="long"/>
- <doc>
- <![CDATA[Set the available memory in MB
-
- @param availableMemoryMB
- the available memory]]>
- </doc>
- </method>
- <method name="getAllocatedMemoryMB" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the allocated memory in MB
-
- @return the allocated memory]]>
- </doc>
- </method>
- <method name="setAllocatedMemoryMB"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocatedMemoryMB" type="long"/>
- <doc>
- <![CDATA[Set the allocated memory in MB
-
- @param allocatedMemoryMB
- the allocate memory]]>
- </doc>
- </method>
- <method name="getPendingMemoryMB" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the pending memory in MB
-
- @return the pending memory]]>
- </doc>
- </method>
- <method name="setPendingMemoryMB"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pendingMemoryMB" type="long"/>
- <doc>
- <![CDATA[Set the pending memory in MB
-
- @param pendingMemoryMB
- the pending memory]]>
- </doc>
- </method>
- <method name="getReservedMemoryMB" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reserved memory in MB
-
- @return the reserved memory]]>
- </doc>
- </method>
- <method name="setReservedMemoryMB"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservedMemoryMB" type="long"/>
- <doc>
- <![CDATA[Set the reserved memory in MB
-
- @param reservedMemoryMB
- the reserved memory]]>
- </doc>
- </method>
- <method name="getAvailableVCores" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the available vcores
-
- @return the available vcores]]>
- </doc>
- </method>
- <method name="setAvailableVCores"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="availableVCores" type="long"/>
- <doc>
- <![CDATA[Set the available vcores
-
- @param availableVCores
- the available vcores]]>
- </doc>
- </method>
- <method name="getAllocatedVCores" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the allocated vcores
-
- @return the allocated vcores]]>
- </doc>
- </method>
- <method name="setAllocatedVCores"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocatedVCores" type="long"/>
- <doc>
- <![CDATA[Set the allocated vcores
-
- @param allocatedVCores
- the allocated vcores]]>
- </doc>
- </method>
- <method name="getPendingVCores" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the pending vcores
-
- @return the pending vcores]]>
- </doc>
- </method>
- <method name="setPendingVCores"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pendingVCores" type="long"/>
- <doc>
- <![CDATA[Set the pending vcores
-
- @param pendingVCores
- the pending vcores]]>
- </doc>
- </method>
- <method name="getPendingContainers" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of pending containers.
- @return the number of pending containers.]]>
- </doc>
- </method>
- <method name="setPendingContainers"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pendingContainers" type="long"/>
- <doc>
- <![CDATA[Set the number of pending containers.
- @param pendingContainers the pending containers.]]>
- </doc>
- </method>
- <method name="getAllocatedContainers" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of allocated containers.
- @return the number of allocated containers.]]>
- </doc>
- </method>
- <method name="setAllocatedContainers"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocatedContainers" type="long"/>
- <doc>
- <![CDATA[Set the number of allocated containers.
- @param allocatedContainers the allocated containers.]]>
- </doc>
- </method>
- <method name="getReservedContainers" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of reserved containers.
- @return the number of reserved containers.]]>
- </doc>
- </method>
- <method name="setReservedContainers"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservedContainers" type="long"/>
- <doc>
- <![CDATA[Set the number of reserved containers.
- @param reservedContainers the reserved containers.]]>
- </doc>
- </method>
- <method name="getReservedVCores" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the reserved vcores
-
- @return the reserved vcores]]>
- </doc>
- </method>
- <method name="setReservedVCores"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reservedVCores" type="long"/>
- <doc>
- <![CDATA[Set the reserved vcores
-
- @param reservedVCores
- the reserved vcores]]>
- </doc>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.QueueStatistics -->
- <!-- 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.RejectedSchedulingRequest -->
- <class name="RejectedSchedulingRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="RejectedSchedulingRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reason" type="org.apache.hadoop.yarn.api.records.RejectionReason"/>
- <param name="request" type="org.apache.hadoop.yarn.api.records.SchedulingRequest"/>
- <doc>
- <![CDATA[Create new RejectedSchedulingRequest.
- @param reason Rejection Reason.
- @param request Rejected Scheduling Request.
- @return RejectedSchedulingRequest.]]>
- </doc>
- </method>
- <method name="getReason" return="org.apache.hadoop.yarn.api.records.RejectionReason"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get Rejection Reason.
- @return Rejection reason.]]>
- </doc>
- </method>
- <method name="setReason"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reason" type="org.apache.hadoop.yarn.api.records.RejectionReason"/>
- <doc>
- <![CDATA[Set Rejection Reason.
- @param reason Rejection Reason.]]>
- </doc>
- </method>
- <method name="getRequest" return="org.apache.hadoop.yarn.api.records.SchedulingRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Rejected Scheduling Request.
- @return SchedulingRequest.]]>
- </doc>
- </method>
- <method name="setRequest"
- 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.SchedulingRequest"/>
- <doc>
- <![CDATA[Set the SchedulingRequest.
- @param request SchedulingRequest.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This encapsulates a Rejected SchedulingRequest. It contains the offending
- Scheduling Request along with the reason for rejection.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.RejectedSchedulingRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.RejectionReason -->
- <class name="RejectionReason" 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.RejectionReason[]"
- 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.RejectionReason"
- 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[Reason for rejecting a Scheduling Request.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.RejectionReason -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationACL -->
- <class name="ReservationACL" 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.ReservationACL[]"
- 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.ReservationACL"
- 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[{@code ReservationACL} enumerates the various ACLs for reservations.
- <p>
- The ACL is one of:
- <ul>
- <li>
- {@link #ADMINISTER_RESERVATIONS} - ACL to create, list, update and
- delete reservations.
- </li>
- <li> {@link #LIST_RESERVATIONS} - ACL to list reservations. </li>
- <li> {@link #SUBMIT_RESERVATIONS} - ACL to create reservations. </li>
- </ul>
- Users can always list, update and delete their own reservations.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationACL -->
- <!-- start class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
- <class name="ReservationAllocationState" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ReservationAllocationState"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ReservationAllocationState"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="acceptanceTime" type="long"/>
- <param name="user" type="java.lang.String"/>
- <param name="resourceAllocations" type="java.util.List"/>
- <param name="reservationId" type="org.apache.hadoop.yarn.api.records.ReservationId"/>
- <param name="reservationDefinition" type="org.apache.hadoop.yarn.api.records.ReservationDefinition"/>
- <doc>
- <![CDATA[@param acceptanceTime The acceptance time of the reservation.
- @param user The username of the user who made the reservation.
- @param resourceAllocations List of {@link ResourceAllocationRequest}
- representing the current state of the
- reservation resource allocations. This is
- subject to change in the event of re-planning.
- @param reservationId {@link ReservationId } of the reservation being
- listed.
- @param reservationDefinition {@link ReservationDefinition} used to make
- the reservation.
- @return {@code ReservationAllocationState} that represents the state of
- the reservation.]]>
- </doc>
- </method>
- <method name="getAcceptanceTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the acceptance time of the reservation.
- @return the time that the reservation was accepted.]]>
- </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 user who made the reservation.
- @return the name of the user who made the reservation.]]>
- </doc>
- </method>
- <method name="getResourceAllocationRequests" return="java.util.List"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the Resource allocations of the reservation based on the current state
- of the plan. This is subject to change in the event of re-planning.
- The allocations will be constraint to the user contract as described by
- the {@link ReservationDefinition}
- @return a list of resource allocations for 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 id of the reservation.
- @return the reservation id corresponding to the reservation.]]>
- </doc>
- </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 reservation definition used to make the reservation.
- @return the reservation definition used to make the reservation.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ReservationAllocationState} represents the reservation that is
- made by a user.
- <p>
- It includes:
- <ul>
- <li>Duration of the reservation.</li>
- <li>Acceptance time of the duration.</li>
- <li>
- List of {@link ResourceAllocationRequest}, which includes the time
- interval, and capability of the allocation.
- {@code ResourceAllocationRequest} represents an allocation
- made for a reservation for the current state of the queue. This can be
- changed for reasons such as re-planning, but will always be subject to
- the constraints of the user contract as described by
- {@link ReservationDefinition}
- </li>
- <li>{@link ReservationId} of the reservation.</li>
- <li>{@link ReservationDefinition} used to make the reservation.</li>
- </ul>
- @see ResourceAllocationRequest
- @see ReservationId
- @see ReservationDefinition]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ReservationAllocationState -->
- <!-- 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"/>
- <param name="recurrenceExpression" type="java.lang.String"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- </method>
- <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>
- <method name="getRecurrenceExpression" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the recurrence of this reservation representing the time period of
- the periodic job. Currently, only long values are supported. Later,
- support for regular expressions denoting arbitrary recurrence patterns
- (e.g., every Tuesday and Thursday) will be added.
- Recurrence is represented in milliseconds for periodic jobs.
- Recurrence is 0 for non-periodic jobs. Periodic jobs are valid until they
- are explicitly cancelled and have higher priority than non-periodic jobs
- (during initial placement and replanning). Periodic job allocations are
- consistent across runs (flexibility in allocation is leveraged only during
- initial placement, allocations remain consistent thereafter). Note that
- as a long, the recurrence expression must be greater than the duration of
- the reservation (deadline - arrival). Also note that the configured max
- period must be divisible by the recurrence expression if expressed as a
- long.
- @return recurrence of this reservation]]>
- </doc>
- </method>
- <method name="setRecurrenceExpression"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="recurrenceExpression" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the recurrence of this reservation representing the time period of
- the periodic job. Currently, only long values are supported. Later,
- support for regular expressions denoting arbitrary recurrence patterns
- (e.g., every Tuesday and Thursday) will be added.
- Recurrence is represented in milliseconds for periodic jobs.
- Recurrence is 0 for non-periodic jobs. Periodic jobs are valid until they
- are explicitly cancelled and have higher priority than non-periodic jobs
- (during initial placement and replanning). Periodic job allocations are
- consistent across runs (flexibility in allocation is leveraged only during
- initial placement, allocations remain consistent thereafter). Note that
- as a long, the recurrence expression must be greater than the duration of
- the reservation (deadline - arrival). Also note that the configured max
- period must be divisible by the recurrence expression if expressed as a
- long.
- @param recurrenceExpression recurrence interval of this reservation]]>
- </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 priority for this reservation. A lower number for priority
- indicates a higher priority reservation. Recurring reservations are
- always higher priority than non-recurring reservations. Priority for
- non-recurring reservations are only compared with non-recurring
- reservations. Likewise for recurring reservations.
- @return int representing the priority of the reserved resource
- allocation in the scheduler]]>
- </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 priority for this reservation. A lower number for priority
- indicates a higher priority reservation. Recurring reservations are
- always higher priority than non-recurring reservations. Priority for
- non-recurring reservations are only compared with non-recurring
- reservations. Likewise for recurring reservations.
- @param priority representing the priority of the 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[{@link ReservationRequest} represents the request made by an application to
- the {@code ResourceManager} to reserve {@link Resource}s.
- <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>]]>
- </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="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="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="long"/>
- <param name="vCores" type="int"/>
- </method>
- <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="long"/>
- <param name="vCores" type="int"/>
- <param name="others" type="java.util.Map"/>
- <doc>
- <![CDATA[Create a new {@link Resource} instance with the given CPU and memory
- values and additional resource values as set in the {@code others}
- parameter. Note that the CPU and memory settings in the {@code others}
- parameter will be ignored.
- @param memory the memory value
- @param vCores the CPU value
- @param others a map of other resource values indexed by resource name
- @return a {@link Resource} instance with the given resource values]]>
- </doc>
- </method>
- <method name="getMemory" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This method is DEPRECATED:
- Use {@link Resource#getMemorySize()} instead
- Get <em>memory</em> of the resource. Note - while memory has
- never had a unit specified, all YARN configurations have specified memory
- in MB. The assumption has been that the daemons and applications are always
- using the same units. With the introduction of the ResourceInformation
- class we have support for units - so this function will continue to return
- memory but in the units of MB
- @return <em>memory</em>(in MB) of the resource]]>
- </doc>
- </method>
- <method name="getMemorySize" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>memory</em> of the resource. Note - while memory has
- never had a unit specified, all YARN configurations have specified memory
- in MB. The assumption has been that the daemons and applications are always
- using the same units. With the introduction of the ResourceInformation
- class we have support for units - so this function will continue to return
- memory but in the units of MB
- @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. Note - while memory has
- never had a unit specified, all YARN configurations have specified memory
- in MB. The assumption has been that the daemons and applications are always
- using the same units. With the introduction of the ResourceInformation
- class we have support for units - so this function will continue to set
- memory but the assumption is that the value passed is in units of MB.
- @param memory <em>memory</em>(in MB) of the resource]]>
- </doc>
- </method>
- <method name="setMemorySize"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="memory" type="long"/>
- <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="getResourceInformation" return="org.apache.hadoop.yarn.api.records.ResourceInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="java.lang.String"/>
- <doc>
- <![CDATA[Get ResourceInformation for a specified resource.
- @param resource name of the resource
- @return the ResourceInformation object for the resource]]>
- </doc>
- </method>
- <method name="getResourceValue" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="java.lang.String"/>
- <doc>
- <![CDATA[Get the value for a specified resource. No information about the units is
- returned.
- @param resource name of the resource
- @return the value for the resource]]>
- </doc>
- </method>
- <method name="setResourceInformation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="java.lang.String"/>
- <param name="resourceInformation" type="org.apache.hadoop.yarn.api.records.ResourceInformation"/>
- <doc>
- <![CDATA[Set the ResourceInformation object for a particular resource.
- @param resource the resource for which the ResourceInformation is provided
- @param resourceInformation ResourceInformation object]]>
- </doc>
- </method>
- <method name="setResourceValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resource" type="java.lang.String"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Set the value of a resource in the ResourceInformation object. The unit of
- the value is assumed to be the one in the ResourceInformation object.
- @param resource the resource for which the value is provided.
- @param value the value to set]]>
- </doc>
- </method>
- <method name="throwExceptionWhenArrayOutOfBound"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="index" type="int"/>
- </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.Resource"/>
- </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="getFormattedString" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This method is to get memory in terms of KB|MB|GB.
- @return string containing all resources]]>
- </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="castToIntSafely" return="int"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Convert long to int for a resource value safely. This method assumes
- resource value is positive.
- @param value long resource value
- @return int resource value]]>
- </doc>
- </method>
- <method name="newDefaultInformation" return="org.apache.hadoop.yarn.api.records.ResourceInformation"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="protected"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- <param name="unit" type="java.lang.String"/>
- <param name="value" type="long"/>
- <doc>
- <![CDATA[Create ResourceInformation with basic fields.
- @param name Resource Type Name
- @param unit Default unit of provided resource type
- @param value Value associated with giveb resource
- @return ResourceInformation object]]>
- </doc>
- </method>
- <field name="resources" type="org.apache.hadoop.yarn.api.records.ResourceInformation[]"
- transient="false" volatile="false"
- static="false" final="false" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="MEMORY_INDEX" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="VCORES_INDEX" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <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.ResourceAllocationRequest -->
- <class name="ResourceAllocationRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceAllocationRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceAllocationRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="startTime" type="long"/>
- <param name="endTime" type="long"/>
- <param name="capability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <doc>
- <![CDATA[@param startTime The start time that the capability is reserved for.
- @param endTime The end time that the capability is reserved for.
- @param capability {@link Resource} representing the capability of the
- resource allocation.
- @return {ResourceAllocationRequest} which represents the capability of
- the resource allocation for a time interval.]]>
- </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 start time that the resource is allocated.
- @return the start time that the resource is allocated.]]>
- </doc>
- </method>
- <method name="getEndTime" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the end time that the resource is allocated.
- @return the end time that the resource is allocated.]]>
- </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 allocated resource.
- @return the allocated resource.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[{@code ResourceAllocationRequest} represents an allocation
- made for a reservation for the current state of the plan. This can be
- changed for reasons such as re-planning, but will always be subject to the
- constraints of the user contract as described by
- {@link ReservationDefinition}
- {@link Resource}
- <p>
- It includes:
- <ul>
- <li>StartTime of the allocation.</li>
- <li>EndTime of the allocation.</li>
- <li>{@link Resource} reserved for the allocation.</li>
- </ul>
- @see Resource]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceAllocationRequest -->
- <!-- 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>
- <field name="OVER_COMMIT_TIMEOUT_MILLIS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Negative value means no timeout.]]>
- </doc>
- </field>
- </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="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"/>
- <param name="executionTypeRequest" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
- </method>
- <method name="clone" 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="rr" type="org.apache.hadoop.yarn.api.records.ResourceRequest"/>
- <doc>
- <![CDATA[Clone a ResourceRequest object (shallow copy). Please keep it loaded with
- all (new) fields
- @param rr the object to copy from
- @return the copied object]]>
- </doc>
- </method>
- <method name="newBuilder" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </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="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="setExecutionTypeRequest"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="execSpec" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
- <doc>
- <![CDATA[Set the <code>ExecutionTypeRequest</code> of the requested container.
- @param execSpec
- ExecutionTypeRequest of the requested container]]>
- </doc>
- </method>
- <method name="getExecutionTypeRequest" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
- abstract="false" 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.
-
- Please note that node label expression now can only take effect when the
- resource request has resourceName = ANY
-
- @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
- specifying a single node label. In the future we will support more complex
- node label expression specification like {@code AND(&&), OR(||)}, etc.
-
- Any please note that node label expression now can only take effect when
- the resource request has resourceName = ANY
-
- @param nodelabelExpression
- node-label-expression of this ResourceRequest]]>
- </doc>
- </method>
- <method name="getAllocationRequestId" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the optional <em>ID</em> corresponding to this allocation request. This
- ID is an identifier for different {@code ResourceRequest}s from the <b>same
- application</b>. The allocated {@code Container}(s) received as part of the
- {@code AllocateResponse} response will have the ID corresponding to the
- original {@code ResourceRequest} for which the RM made the allocation.
- <p>
- The scheduler may return multiple {@code AllocateResponse}s corresponding
- to the same ID as and when scheduler allocates {@code Container}(s).
- <b>Applications</b> can continue to completely ignore the returned ID in
- the response and use the allocation for any of their outstanding requests.
- <p>
- If one wishes to replace an entire {@code ResourceRequest} corresponding to
- a specific ID, they can simply cancel the corresponding {@code
- ResourceRequest} and submit a new one afresh.
- @return the <em>ID</em> corresponding to this allocation request.]]>
- </doc>
- </method>
- <method name="setAllocationRequestId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocationRequestID" type="long"/>
- <doc>
- <![CDATA[Set the optional <em>ID</em> corresponding to this allocation request. This
- ID is an identifier for different {@code ResourceRequest}s from the <b>same
- application</b>. The allocated {@code Container}(s) received as part of the
- {@code AllocateResponse} response will have the ID corresponding to the
- original {@code ResourceRequest} for which the RM made the allocation.
- <p>
- The scheduler may return multiple {@code AllocateResponse}s corresponding
- to the same ID as and when scheduler allocates {@code Container}(s).
- <b>Applications</b> can continue to completely ignore the returned ID in
- the response and use the allocation for any of their outstanding requests.
- <p>
- If one wishes to replace an entire {@code ResourceRequest} corresponding to
- a specific ID, they can simply cancel the corresponding {@code
- ResourceRequest} and submit a new one afresh.
- <p>
- If the ID is not set, scheduler will continue to work as previously and all
- allocated {@code Container}(s) will have the default ID, -1.
- @param allocationRequestID the <em>ID</em> corresponding to this allocation
- 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="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="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[{@code ResourceRequest} represents the request made
- by an application to the {@code ResourceManager}
- to obtain various {@code Container} allocations.
- <p>
- It includes:
- <ul>
- <li>{@link Priority} of the request.</li>
- <li>
- The <em>name</em> of the host 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},
- which tells the {@code ResourceManager} 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>
-
- @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.ResourceRequestBuilder -->
- <class name="ResourceRequest.ResourceRequestBuilder" extends="java.lang.Object"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="priority" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" 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.
- @see ResourceRequest#setPriority(Priority)
- @param priority <code>priority</code> of the request
- @return {@link ResourceRequestBuilder}]]>
- </doc>
- </method>
- <method name="resourceName" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceName" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>resourceName</code> of the request.
- @see ResourceRequest#setResourceName(String)
- @param resourceName <code>resourceName</code> of the request
- @return {@link ResourceRequestBuilder}]]>
- </doc>
- </method>
- <method name="capability" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" 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>capability</code> of the request.
- @see ResourceRequest#setCapability(Resource)
- @param capability <code>capability</code> of the request
- @return {@link ResourceRequestBuilder}]]>
- </doc>
- </method>
- <method name="numContainers" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numContainers" type="int"/>
- <doc>
- <![CDATA[Set the <code>numContainers</code> of the request.
- @see ResourceRequest#setNumContainers(int)
- @param numContainers <code>numContainers</code> of the request
- @return {@link ResourceRequestBuilder}]]>
- </doc>
- </method>
- <method name="relaxLocality" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relaxLocality" type="boolean"/>
- <doc>
- <![CDATA[Set the <code>relaxLocality</code> of the request.
- @see ResourceRequest#setRelaxLocality(boolean)
- @param relaxLocality <code>relaxLocality</code> of the request
- @return {@link ResourceRequestBuilder}]]>
- </doc>
- </method>
- <method name="nodeLabelExpression" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="nodeLabelExpression" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the <code>nodeLabelExpression</code> of the request.
- @see ResourceRequest#setNodeLabelExpression(String)
- @param nodeLabelExpression
- <code>nodeLabelExpression</code> of the request
- @return {@link ResourceRequestBuilder}]]>
- </doc>
- </method>
- <method name="executionTypeRequest" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="executionTypeRequest" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
- <doc>
- <![CDATA[Set the <code>executionTypeRequest</code> of the request.
- @see ResourceRequest#setExecutionTypeRequest(
- ExecutionTypeRequest)
- @param executionTypeRequest
- <code>executionTypeRequest</code> of the request
- @return {@link ResourceRequestBuilder}]]>
- </doc>
- </method>
- <method name="executionType" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
- <doc>
- <![CDATA[Set the <code>executionTypeRequest</code> of the request with 'ensure
- execution type' flag set to true.
- @see ResourceRequest#setExecutionTypeRequest(
- ExecutionTypeRequest)
- @param executionType <code>executionType</code> of the request.
- @return {@link ResourceRequestBuilder}]]>
- </doc>
- </method>
- <method name="allocationRequestId" return="org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocationRequestId" type="long"/>
- <doc>
- <![CDATA[Set the <code>allocationRequestId</code> of the request.
- @see ResourceRequest#setAllocationRequestId(long)
- @param allocationRequestId
- <code>allocationRequestId</code> of the request
- @return {@link ResourceRequestBuilder}]]>
- </doc>
- </method>
- <method name="build" return="org.apache.hadoop.yarn.api.records.ResourceRequest"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return generated {@link ResourceRequest} object.
- @return {@link ResourceRequest}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Class to construct instances of {@link ResourceRequest} with specific
- options.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceRequest.ResourceRequestBuilder -->
- <!-- 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="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.ResourceSizing -->
- <class name="ResourceSizing" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceSizing"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceSizing"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resources" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceSizing"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numAllocations" type="int"/>
- <param name="resources" type="org.apache.hadoop.yarn.api.records.Resource"/>
- </method>
- <method name="getNumAllocations" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setNumAllocations"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="numAllocations" type="int"/>
- </method>
- <method name="getResources" 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="setResources"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resources" 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="obj" type="java.lang.Object"/>
- </method>
- <doc>
- <![CDATA[{@code ResourceSizing} contains information for the size of a
- {@link SchedulingRequest}, such as the number of requested allocations and
- the resources for each allocation.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceSizing -->
- <!-- start class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
- <class name="ResourceUtilization" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="ResourceUtilization"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pmem" type="int"/>
- <param name="vmem" type="int"/>
- <param name="cpu" type="float"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pmem" type="int"/>
- <param name="vmem" type="int"/>
- <param name="cpu" type="float"/>
- <param name="customResources" type="java.util.Map"/>
- </method>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.ResourceUtilization"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceUtil" type="org.apache.hadoop.yarn.api.records.ResourceUtilization"/>
- </method>
- <method name="getVirtualMemory" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get used <em>virtual memory</em>.
- @return <em>virtual memory</em> in MB]]>
- </doc>
- </method>
- <method name="setVirtualMemory"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="vmem" type="int"/>
- <doc>
- <![CDATA[Set used <em>virtual memory</em>.
- @param vmem <em>virtual memory</em> in MB]]>
- </doc>
- </method>
- <method name="getPhysicalMemory" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>physical memory</em>.
- @return <em>physical memory</em> in MB]]>
- </doc>
- </method>
- <method name="setPhysicalMemory"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pmem" type="int"/>
- <doc>
- <![CDATA[Set <em>physical memory</em>.
- @param pmem <em>physical memory</em> in MB]]>
- </doc>
- </method>
- <method name="getCPU" return="float"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get <em>CPU</em> utilization (The amount of vcores used).
- @return <em>CPU utilization</em>]]>
- </doc>
- </method>
- <method name="setCPU"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cpu" type="float"/>
- <doc>
- <![CDATA[Set <em>CPU</em> utilization (The amount of vcores used).
- @param cpu <em>CPU utilization</em>]]>
- </doc>
- </method>
- <method name="getCustomResource" return="float"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceName" type="java.lang.String"/>
- <doc>
- <![CDATA[Get <em>custom resource</em> utilization
- (The amount of custom resource used).
- @param resourceName <em>resourceName of custom resource</em>
- @return <em>resourceName utilization</em>]]>
- </doc>
- </method>
- <method name="getCustomResources" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCustomResources"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="customResources" type="java.util.Map"/>
- </method>
- <method name="setCustomResource"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceName" type="java.lang.String"/>
- <param name="utilization" type="float"/>
- <doc>
- <![CDATA[Set <em>custom resource</em> utilization
- (The amount of custom resource used).
- @param resourceName <em>resourceName</em>
- @param utilization <em>utilization of custom resource</em>]]>
- </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>
- <method name="addTo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pmem" type="int"/>
- <param name="vmem" type="int"/>
- <param name="cpu" type="float"/>
- <doc>
- <![CDATA[Add utilization to the current one.
- @param pmem Physical memory used to add.
- @param vmem Virtual memory used to add.
- @param cpu CPU utilization to add.]]>
- </doc>
- </method>
- <method name="addTo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pmem" type="int"/>
- <param name="vmem" type="int"/>
- <param name="cpu" type="float"/>
- <param name="resourceName" type="java.lang.String"/>
- <param name="utilization" type="float"/>
- <doc>
- <![CDATA[Add utilization to the current one.
- @param pmem Physical memory used to add.
- @param vmem Virtual memory used to add.
- @param cpu CPU utilization to add.
- @param resourceName of custom resource to add.
- @param utilization of custom resource to add.]]>
- </doc>
- </method>
- <method name="subtractFrom"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pmem" type="int"/>
- <param name="vmem" type="int"/>
- <param name="cpu" type="float"/>
- <doc>
- <![CDATA[Subtract utilization from the current one.
- @param pmem Physical memory to be subtracted.
- @param vmem Virtual memory to be subtracted.
- @param cpu CPU utilization to be subtracted.]]>
- </doc>
- </method>
- <method name="subtractFrom"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="pmem" type="int"/>
- <param name="vmem" type="int"/>
- <param name="cpu" type="float"/>
- <param name="resourceName" type="java.lang.String"/>
- <param name="utilization" type="float"/>
- <doc>
- <![CDATA[Subtract utilization from the current one.
- @param pmem Physical memory to be subtracted.
- @param vmem Virtual memory to be subtracted.
- @param cpu CPU utilization to be subtracted.
- @param resourceName of custom resource to be subtracted.
- @param utilization of custom resource to be subtracted.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- <code>ResourceUtilization</code> models the utilization of a set of computer
- resources in the cluster.
- </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ResourceUtilization -->
- <!-- start class org.apache.hadoop.yarn.api.records.SchedulingRequest -->
- <class name="SchedulingRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SchedulingRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.SchedulingRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocationRequestId" type="long"/>
- <param name="priority" type="org.apache.hadoop.yarn.api.records.Priority"/>
- <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
- <param name="allocationTags" type="java.util.Set"/>
- <param name="resourceSizing" type="org.apache.hadoop.yarn.api.records.ResourceSizing"/>
- <param name="placementConstraintExpression" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint"/>
- </method>
- <method name="newBuilder" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getAllocationRequestId" return="long"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAllocationRequestId"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocationRequestId" type="long"/>
- </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">
- </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="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setExecutionType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
- </method>
- <method name="getAllocationTags" return="java.util.Set"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAllocationTags"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocationTags" type="java.util.Set"/>
- </method>
- <method name="getResourceSizing" return="org.apache.hadoop.yarn.api.records.ResourceSizing"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setResourceSizing"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceSizing" type="org.apache.hadoop.yarn.api.records.ResourceSizing"/>
- </method>
- <method name="getPlacementConstraint" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setPlacementConstraint"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="placementConstraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint"/>
- </method>
- <doc>
- <![CDATA[{@code SchedulingRequest} represents a request made by an application to the
- {@code ResourceManager} to obtain an allocation. It is similar to the
- {@link ResourceRequest}. However, it is more complete than the latter, as it
- allows applications to specify allocation tags (e.g., to express that an
- allocation belongs to {@code Spark} or is an {@code HBase-master}), as well
- as involved {@link PlacementConstraint}s (e.g., anti-affinity between Spark
- and HBase allocations).
- The size specification of the allocation is in {@code ResourceSizing}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.SchedulingRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder -->
- <class name="SchedulingRequest.SchedulingRequestBuilder" extends="java.lang.Object"
- abstract="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="allocationRequestId" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocationRequestId" type="long"/>
- <doc>
- <![CDATA[Set the <code>allocationRequestId</code> of the request.
- @see SchedulingRequest#setAllocationRequestId(long)
- @param allocationRequestId <code>allocationRequestId</code> of the
- request
- @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
- </doc>
- </method>
- <method name="priority" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
- abstract="false" 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
- @return {@link SchedulingRequest.SchedulingRequestBuilder}
- @see SchedulingRequest#setPriority(Priority)]]>
- </doc>
- </method>
- <method name="executionType" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionTypeRequest"/>
- <doc>
- <![CDATA[Set the <code>executionType</code> of the request.
- @see SchedulingRequest#setExecutionType(ExecutionTypeRequest)
- @param executionType <code>executionType</code> of the request
- @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
- </doc>
- </method>
- <method name="allocationTags" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="allocationTags" type="java.util.Set"/>
- <doc>
- <![CDATA[Set the <code>allocationTags</code> of the request.
- @see SchedulingRequest#setAllocationTags(Set)
- @param allocationTags <code>allocationsTags</code> of the request
- @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
- </doc>
- </method>
- <method name="resourceSizing" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="resourceSizing" type="org.apache.hadoop.yarn.api.records.ResourceSizing"/>
- <doc>
- <![CDATA[Set the <code>executionType</code> of the request.
- @see SchedulingRequest#setResourceSizing(ResourceSizing)
- @param resourceSizing <code>resourceSizing</code> of the request
- @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
- </doc>
- </method>
- <method name="placementConstraintExpression" return="org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="placementConstraintExpression" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint"/>
- <doc>
- <![CDATA[Set the <code>placementConstraintExpression</code> of the request.
- @see SchedulingRequest#setPlacementConstraint(
- PlacementConstraint)
- @param placementConstraintExpression <code>placementConstraints</code> of
- the request
- @return {@link SchedulingRequest.SchedulingRequestBuilder}]]>
- </doc>
- </method>
- <method name="build" return="org.apache.hadoop.yarn.api.records.SchedulingRequest"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Return generated {@link SchedulingRequest} object.
- @return {@link SchedulingRequest}]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Class to construct instances of {@link SchedulingRequest} with specific
- options.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.SchedulingRequest.SchedulingRequestBuilder -->
- <!-- start class org.apache.hadoop.yarn.api.records.ShellContainerCommand -->
- <class name="ShellContainerCommand" 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.ShellContainerCommand[]"
- 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.ShellContainerCommand"
- 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 signal container commands.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.ShellContainerCommand -->
- <!-- start class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
- <class name="SignalContainerCommand" 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.SignalContainerCommand[]"
- 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.SignalContainerCommand"
- 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 signal container commands.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.SignalContainerCommand -->
- <!-- 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.UpdateContainerError -->
- <class name="UpdateContainerError" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UpdateContainerError"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerError"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reason" type="java.lang.String"/>
- <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
- </method>
- <method name="getReason" return="java.lang.String"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get reason why the update request was not satisfiable.
- @return Reason]]>
- </doc>
- </method>
- <method name="setReason"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="reason" type="java.lang.String"/>
- <doc>
- <![CDATA[Set reason why the update request was not satisfiable.
- @param reason Reason]]>
- </doc>
- </method>
- <method name="getCurrentContainerVersion" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get current container version.
- @return Current container Version.]]>
- </doc>
- </method>
- <method name="setCurrentContainerVersion"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="currentVersion" type="int"/>
- <doc>
- <![CDATA[Set current container version.
- @param currentVersion Current container version.]]>
- </doc>
- </method>
- <method name="getUpdateContainerRequest" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the {@code UpdateContainerRequest} that was not satisfiable.
- @return UpdateContainerRequest]]>
- </doc>
- </method>
- <method name="setUpdateContainerRequest"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updateContainerRequest" type="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"/>
- <doc>
- <![CDATA[Set the {@code UpdateContainerRequest} that was not satisfiable.
- @param updateContainerRequest Update Container Request]]>
- </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="toString" return="java.lang.String"
- 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[{@code UpdateContainerError} is used by the Scheduler to notify the
- ApplicationMaster of an UpdateContainerRequest it cannot satisfy due to
- an error in the request. It includes the update request as well as
- a reason for why the request was not satisfiable.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerError -->
- <!-- start class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
- <class name="UpdateContainerRequest" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UpdateContainerRequest"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdateContainerRequest"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="version" type="int"/>
- <param name="containerId" type="org.apache.hadoop.yarn.api.records.ContainerId"/>
- <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
- <param name="targetCapability" type="org.apache.hadoop.yarn.api.records.Resource"/>
- <param name="targetExecutionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
- </method>
- <method name="getContainerVersion" return="int"
- 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="setContainerVersion"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="containerVersion" type="int"/>
- <doc>
- <![CDATA[Set the current version of the container.
- @param containerVersion of the container]]>
- </doc>
- </method>
- <method name="getContainerUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerUpdateType</code> of the container.
- @return <code>ContainerUpdateType</code> of the container.]]>
- </doc>
- </method>
- <method name="setContainerUpdateType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
- <doc>
- <![CDATA[Set the <code>ContainerUpdateType</code> of the container.
- @param updateType of the Container]]>
- </doc>
- </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>
- <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the target <code>ExecutionType</code> of the container.
- @return <code>ExecutionType</code> of the container]]>
- </doc>
- </method>
- <method name="setExecutionType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="executionType" type="org.apache.hadoop.yarn.api.records.ExecutionType"/>
- <doc>
- <![CDATA[Set the target <code>ExecutionType</code> of the container.
- @param executionType <code>ExecutionType</code> of the container]]>
- </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="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="hashCode" return="int"
- 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="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[{@code UpdateContainerRequest} represents the request made by an
- application to the {@code ResourceManager} to update an attribute of a
- {@code Container} such as its Resource allocation or (@code ExecutionType}
- <p>
- It includes:
- <ul>
- <li>version for the container.</li>
- <li>{@link ContainerId} for the container.</li>
- <li>
- {@link Resource} capability of the container after the update request
- is completed.
- </li>
- <li>
- {@link ExecutionType} of the container after the update request is
- completed.
- </li>
- </ul>
- Update rules:
- <ul>
- <li>
- Currently only ONE aspect of the container can be updated per request
- (user can either update Capability OR ExecutionType in one request..
- not both).
- </li>
- <li>
- There must be only 1 update request per container in an allocate call.
- </li>
- <li>
- If a new update request is sent for a container (in a subsequent allocate
- call) before the first one is satisfied by the Scheduler, it will
- overwrite the previous request.
- </li>
- </ul>
- @see ApplicationMasterProtocol#allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest)]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.UpdateContainerRequest -->
- <!-- start class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
- <class name="UpdatedContainer" extends="java.lang.Object"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UpdatedContainer"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.UpdatedContainer"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
- <param name="container" type="org.apache.hadoop.yarn.api.records.Container"/>
- <doc>
- <![CDATA[Static Factory method.
- @param updateType ContainerUpdateType
- @param container Container
- @return UpdatedContainer]]>
- </doc>
- </method>
- <method name="getUpdateType" return="org.apache.hadoop.yarn.api.records.ContainerUpdateType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>ContainerUpdateType</code>.
- @return ContainerUpdateType]]>
- </doc>
- </method>
- <method name="setUpdateType"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="updateType" type="org.apache.hadoop.yarn.api.records.ContainerUpdateType"/>
- <doc>
- <![CDATA[Set the <code>ContainerUpdateType</code>.
- @param updateType ContainerUpdateType]]>
- </doc>
- </method>
- <method name="getContainer" return="org.apache.hadoop.yarn.api.records.Container"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>Container</code>.
- @return Container]]>
- </doc>
- </method>
- <method name="setContainer"
- 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.Container"/>
- <doc>
- <![CDATA[Set the <code>Container</code>.
- @param container Container]]>
- </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>
- <doc>
- <![CDATA[An object that encapsulates an updated container and the
- type of Update.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.UpdatedContainer -->
- <!-- 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>
- <method name="toPath" return="org.apache.hadoop.fs.Path"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <exception name="URISyntaxException" type="java.net.URISyntaxException"/>
- </method>
- <method name="fromURI" 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="uri" type="java.net.URI"/>
- </method>
- <method name="fromPath" 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="path" type="org.apache.hadoop.fs.Path"/>
- </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>
- <method name="getNumDecommissionedNodeManagers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of <code>DecommissionedNodeManager</code>s in the cluster.
-
- @return number of <code>DecommissionedNodeManager</code>s in the cluster]]>
- </doc>
- </method>
- <method name="getNumActiveNodeManagers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of <code>ActiveNodeManager</code>s in the cluster.
-
- @return number of <code>ActiveNodeManager</code>s in the cluster]]>
- </doc>
- </method>
- <method name="getNumLostNodeManagers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of <code>LostNodeManager</code>s in the cluster.
-
- @return number of <code>LostNodeManager</code>s in the cluster]]>
- </doc>
- </method>
- <method name="getNumUnhealthyNodeManagers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of <code>UnhealthyNodeManager</code>s in the cluster.
-
- @return number of <code>UnhealthyNodeManager</code>s in the cluster]]>
- </doc>
- </method>
- <method name="getNumRebootedNodeManagers" return="int"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the number of <code>RebootedNodeManager</code>s in the cluster.
-
- @return number of <code>RebootedNodeManager</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.impl">
- </package>
- <package name="org.apache.hadoop.yarn.api.records.timeline">
- <!-- start class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
- <class name="TimelineAbout" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineAbout"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TimelineAbout" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getAbout" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setAbout"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="about" type="java.lang.String"/>
- </method>
- <method name="getTimelineServiceVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setTimelineServiceVersion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timelineServiceVersion" type="java.lang.String"/>
- </method>
- <method name="getTimelineServiceBuildVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setTimelineServiceBuildVersion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timelineServiceBuildVersion" type="java.lang.String"/>
- </method>
- <method name="getTimelineServiceVersionBuiltOn" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setTimelineServiceVersionBuiltOn"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timelineServiceVersionBuiltOn" type="java.lang.String"/>
- </method>
- <method name="getHadoopVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setHadoopVersion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hadoopVersion" type="java.lang.String"/>
- </method>
- <method name="getHadoopBuildVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setHadoopBuildVersion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hadoopBuildVersion" type="java.lang.String"/>
- </method>
- <method name="getHadoopVersionBuiltOn" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setHadoopVersionBuiltOn"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="hadoopVersionBuiltOn" type="java.lang.String"/>
- </method>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineAbout -->
- <!-- 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.TimelineEntityGroupId -->
- <class name="TimelineEntityGroupId" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <implements name="java.lang.Comparable"/>
- <constructor name="TimelineEntityGroupId"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="newInstance" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
- 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="id" type="java.lang.String"/>
- </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 the <code>ApplicationId</code> of the
- <code>TimelineEntityGroupId</code>.
- @return <code>ApplicationId</code> of the
- <code>TimelineEntityGroupId</code>]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appID" type="org.apache.hadoop.yarn.api.records.ApplicationId"/>
- </method>
- <method name="getTimelineEntityGroupId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the <code>timelineEntityGroupId</code>.
- @return <code>timelineEntityGroupId</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.timeline.TimelineEntityGroupId"/>
- </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="fromString" return="org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timelineEntityGroupIdStr" type="java.lang.String"/>
- </method>
- <field name="TIMELINE_ENTITY_GROUPID_STR_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[<p><code>TimelineEntityGroupId</code> is an abstract way for
- timeline service users to represent #a group of related timeline data.
- For example, all entities that represents one data flow DAG execution
- can be grouped into one timeline entity group. </p>]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineEntityGroupId -->
- <!-- 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="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.TimelineHealth -->
- <class name="TimelineHealth" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineHealth" type="org.apache.hadoop.yarn.api.records.timeline.TimelineHealth.TimelineHealthStatus, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TimelineHealth"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getHealthStatus" return="org.apache.hadoop.yarn.api.records.timeline.TimelineHealth.TimelineHealthStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getDiagnosticsInfo" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setHealthStatus"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="healthStatus" type="org.apache.hadoop.yarn.api.records.timeline.TimelineHealth.TimelineHealthStatus"/>
- </method>
- <method name="setDiagnosticsInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="diagnosticsInfo" type="java.lang.String"/>
- </method>
- <doc>
- <![CDATA[This class holds health information for ATS.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timeline.TimelineHealth -->
- <!-- 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="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>
- <field name="EXPIRED_ENTITY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Error code returned if the entity start time is before the eviction
- period of old data.]]>
- </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.api.records.timelineservice">
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationAttemptEntity -->
- <class name="ApplicationAttemptEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationAttemptEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationAttemptEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This entity represents an application attempt.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationAttemptEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationEntity -->
- <class name="ApplicationEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ApplicationEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ApplicationEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getQueue" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setQueue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="queue" type="java.lang.String"/>
- </method>
- <method name="isApplicationEntity" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
- <doc>
- <![CDATA[Checks if the input TimelineEntity object is an ApplicationEntity.
- @param te TimelineEntity object.
- @return true if input is an ApplicationEntity, false otherwise]]>
- </doc>
- </method>
- <method name="getApplicationEvent" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
- <param name="eventId" type="java.lang.String"/>
- <doc>
- <![CDATA[@param te TimelineEntity object.
- @param eventId event with this id needs to be fetched
- @return TimelineEvent if TimelineEntity contains the desired event.]]>
- </doc>
- </method>
- <field name="QUEUE_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This entity represents an application.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ApplicationEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ClusterEntity -->
- <class name="ClusterEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ClusterEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ClusterEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This entity represents a YARN cluster.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ClusterEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.ContainerEntity -->
- <class name="ContainerEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This entity represents a container belonging to an application attempt.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.ContainerEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.FlowActivityEntity -->
- <class name="FlowActivityEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FlowActivityEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FlowActivityEntity" type="java.lang.String, long, java.lang.String, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FlowActivityEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- 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">
- </method>
- <method name="compareTo" return="int"
- 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.timelineservice.TimelineEntity"/>
- </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"/>
- <doc>
- <![CDATA[Reuse the base class equals method.]]>
- </doc>
- </method>
- <method name="hashCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Reuse the base class hashCode method.]]>
- </doc>
- </method>
- <method name="getCluster" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCluster"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="cluster" type="java.lang.String"/>
- </method>
- <method name="getDate" return="java.util.Date"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setDate"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="time" type="long"/>
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- </method>
- <method name="getFlowName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setFlowName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="flowName" type="java.lang.String"/>
- </method>
- <method name="addFlowRun"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="run" type="org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity"/>
- </method>
- <method name="addFlowRuns"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="runs" type="java.util.Collection"/>
- </method>
- <method name="getFlowRuns" return="java.util.NavigableSet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="getNumberOfRuns" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <field name="CLUSTER_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DATE_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="USER_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOW_NAME_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Entity that represents a record for flow activity. It's essentially a
- container entity for flow runs with limited information.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.FlowActivityEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity -->
- <class name="FlowRunEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="FlowRunEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="FlowRunEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- 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">
- </method>
- <method name="getUser" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setUser"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="user" type="java.lang.String"/>
- </method>
- <method name="getName" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setName"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="name" type="java.lang.String"/>
- </method>
- <method name="getVersion" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setVersion"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="version" type="java.lang.String"/>
- </method>
- <method name="getRunId" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setRunId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="runId" type="long"/>
- </method>
- <method name="getStartTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setStartTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="startTime" type="long"/>
- </method>
- <method name="getMaxEndTime" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setMaxEndTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="endTime" type="long"/>
- </method>
- <field name="USER_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOW_NAME_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOW_VERSION_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOW_RUN_ID_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FLOW_RUN_END_TIME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This entity represents a flow run.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.FlowRunEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity -->
- <class name="HierarchicalTimelineEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getParent" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setParent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="parent" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
- </method>
- <method name="setParent"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="java.lang.String"/>
- <param name="id" type="java.lang.String"/>
- </method>
- <method name="getChildren" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setChildren"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="children" type="java.util.Set"/>
- </method>
- <method name="addChildren"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="children" type="java.util.Set"/>
- </method>
- <method name="addChild"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="child" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
- </method>
- <method name="addChild"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="java.lang.String"/>
- <param name="id" type="java.lang.String"/>
- </method>
- <field name="PARENT_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CHILDREN_INFO_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class extends timeline entity and defines parent-child relationships
- with other entities.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.QueueEntity -->
- <class name="QueueEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="QueueEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="QueueEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This entity represents a queue.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.QueueEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.SubApplicationEntity -->
- <class name="SubApplicationEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.HierarchicalTimelineEntity"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="SubApplicationEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="isSubApplicationEntity" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="te" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"/>
- <doc>
- <![CDATA[Checks if the input TimelineEntity object is an SubApplicationEntity.
- @param te TimelineEntity object.
- @return true if input is an SubApplicationEntity, false otherwise]]>
- </doc>
- </method>
- <method name="setApplicationId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="appId" type="java.lang.String"/>
- </method>
- <field name="YARN_APPLICATION_ID" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This entity represents a user defined entities to be stored under sub
- application table.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.SubApplicationEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.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 service 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 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.timelineservice.TimelineDomain -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.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">
- </method>
- <method name="setEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timelineEntities" type="java.util.List"/>
- </method>
- <method name="addEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timelineEntities" type="java.util.List"/>
- </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.timelineservice.TimelineEntity"/>
- </method>
- <doc>
- <![CDATA[This class hosts a set of timeline entities.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntities -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.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>
- <constructor name="TimelineEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[<p>
- The constuctor is used to construct a proxy {@link TimelineEntity} or its
- subclass object from the real entity object that carries information.
- </p>
- <p>
- It is usually used in the case where we want to recover class polymorphism
- after deserializing the entity from its JSON form.
- </p>
- @param entity the real entity that carries information]]>
- </doc>
- </constructor>
- <constructor name="TimelineEntity" type="java.lang.String"
- static="false" final="false" visibility="protected"
- 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="getId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </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"/>
- </method>
- <method name="getIdentifier" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setIdentifier"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityIdentifier" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity.Identifier"/>
- </method>
- <method name="getInfo" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityInfos" type="java.util.Map"/>
- </method>
- <method name="addInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityInfos" type="java.util.Map"/>
- </method>
- <method name="addInfo"
- 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"/>
- </method>
- <method name="getConfigs" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setConfigs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityConfigs" type="java.util.Map"/>
- </method>
- <method name="addConfigs"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityConfigs" type="java.util.Map"/>
- </method>
- <method name="addConfig"
- 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.String"/>
- </method>
- <method name="getMetrics" return="java.util.Set"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityMetrics" type="java.util.Set"/>
- </method>
- <method name="addMetrics"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityMetrics" type="java.util.Set"/>
- </method>
- <method name="addMetric"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
- </method>
- <method name="getEvents" return="java.util.NavigableSet"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityEvents" type="java.util.NavigableSet"/>
- </method>
- <method name="addEvents"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityEvents" type="java.util.Set"/>
- </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.timelineservice.TimelineEvent"/>
- </method>
- <method name="getIsRelatedToEntities" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setIsRelatedToEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="isRelatedTo" type="java.util.Map"/>
- </method>
- <method name="addIsRelatedToEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="isRelatedTo" type="java.util.Map"/>
- </method>
- <method name="addIsRelatedToEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="java.lang.String"/>
- <param name="id" type="java.lang.String"/>
- </method>
- <method name="getRelatesToEntities" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="addRelatesToEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relatesTo" type="java.util.Map"/>
- </method>
- <method name="addRelatesToEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="java.lang.String"/>
- <param name="id" type="java.lang.String"/>
- </method>
- <method name="setRelatesToEntities"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="relatesTo" type="java.util.Map"/>
- </method>
- <method name="getCreatedTime" return="java.lang.Long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setCreatedTime"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="createdTs" type="java.lang.Long"/>
- </method>
- <method name="setUID"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="uidKey" type="java.lang.String"/>
- <param name="uId" type="java.lang.String"/>
- <doc>
- <![CDATA[Set UID in info which will be then used for query by UI.
- @param uidKey key for UID in info.
- @param uId UID to be set for the key.]]>
- </doc>
- </method>
- <method name="isValid" return="boolean"
- 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.timelineservice.TimelineEntity"/>
- </method>
- <method name="getReal" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="protected"
- 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="getIdPrefix" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setIdPrefix"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="entityIdPrefix" type="long"/>
- <doc>
- <![CDATA[Sets idPrefix for an entity.
- <p>
- <b>Note</b>: Entities will be stored in the order of idPrefix specified.
- If users decide to set idPrefix for an entity, they <b>MUST</b> provide
- the same prefix for every update of this entity.
- </p>
- Example: <blockquote><pre>
- TimelineEntity entity = new TimelineEntity();
- entity.setIdPrefix(value);
- </pre></blockquote>
- Users can use {@link TimelineServiceHelper#invertLong(long)} to invert
- the prefix if necessary.
- @param entityIdPrefix prefix for an entity.]]>
- </doc>
- </method>
- <field name="SYSTEM_INFO_KEY_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="protected"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ENTITY_PREFIX" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[The basic timeline entity data structure for timeline service v2. Timeline
- entity objects are not thread safe and should not be accessed concurrently.
- All collection members will be initialized into empty collections. Two
- timeline entities are equal iff. their type and id are identical.
- All non-primitive type, non-collection members will be initialized into null.
- User should set the type and id of a timeline entity to make it valid (can be
- checked by using the {@link #isValid()} method). Callers to the getters
- should perform null checks for non-primitive type, non-collection members.
- Callers are recommended not to alter the returned collection objects from the
- getters.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType -->
- <class name="TimelineEntityType" 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.timelineservice.TimelineEntityType[]"
- 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.timelineservice.TimelineEntityType"
- 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="isParent" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"/>
- <doc>
- <![CDATA[Whether the input type can be a parent of this entity.
- @param type entity type.
- @return true, if this entity type is parent of passed entity type, false
- otherwise.]]>
- </doc>
- </method>
- <method name="isChild" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="type" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType"/>
- <doc>
- <![CDATA[Whether the input type can be a child of this entity.
- @param type entity type.
- @return true, if this entity type is child of passed entity type, false
- otherwise.]]>
- </doc>
- </method>
- <method name="matches" return="boolean"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="typeString" type="java.lang.String"/>
- <doc>
- <![CDATA[Whether the type of this entity matches the type indicated by the input
- argument.
- @param typeString entity type represented as a string.
- @return true, if string representation of this entity type matches the
- entity type passed.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Defines type of entity.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntityType -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.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="getId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="eventId" type="java.lang.String"/>
- </method>
- <method name="getInfo" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="infos" type="java.util.Map"/>
- </method>
- <method name="addInfo"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="infos" type="java.util.Map"/>
- </method>
- <method name="addInfo"
- 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"/>
- </method>
- <method name="getTimestamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setTimestamp"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="ts" type="long"/>
- </method>
- <method name="isValid" return="boolean"
- 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="o" 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.timelineservice.TimelineEvent"/>
- </method>
- <field name="INVALID_TIMESTAMP" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class contains the information of an event that belongs to an entity.
- Users are free to define what the event means, such as starting an
- application, container being allocated, etc.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineEvent -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric -->
- <class name="TimelineMetric" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineMetric"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="TimelineMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <method name="getType" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"
- 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="metricType" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric.Type"/>
- </method>
- <method name="getId" return="java.lang.String"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setId"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metricId" type="java.lang.String"/>
- </method>
- <method name="getRealtimeAggregationOp" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetricOperation"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the real time aggregation operation of this metric.
- @return Real time aggregation operation]]>
- </doc>
- </method>
- <method name="setRealtimeAggregationOp"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="op" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetricOperation"/>
- <doc>
- <![CDATA[Set the real time aggregation operation of this metric.
- @param op A timeline metric operation that the metric should perform on
- real time aggregations]]>
- </doc>
- </method>
- <method name="getValues" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </method>
- <method name="setValues"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="vals" type="java.util.Map"/>
- </method>
- <method name="addValues"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="vals" type="java.util.Map"/>
- </method>
- <method name="addValue"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="timestamp" type="long"/>
- <param name="value" type="java.lang.Number"/>
- </method>
- <method name="isValid" return="boolean"
- 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="o" 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>
- <method name="getLatestSingleValueMetric" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="metric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
- <doc>
- <![CDATA[Get the latest timeline metric as single value type.
- @param metric Incoming timeline metric
- @return The latest metric in the incoming metric]]>
- </doc>
- </method>
- <method name="getSingleDataTimestamp" return="long"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get single data timestamp of the metric.
- @return the single data timestamp]]>
- </doc>
- </method>
- <method name="getSingleDataValue" return="java.lang.Number"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get single data value of the metric.
- @return the single data value]]>
- </doc>
- </method>
- <method name="aggregateTo" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="incomingMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
- <param name="baseAggregatedMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
- <doc>
- <![CDATA[Aggregate an incoming metric to the base aggregated metric with the given
- operation state in a stateless fashion. The assumption here is
- baseAggregatedMetric and latestMetric should be single value data if not
- null.
- @param incomingMetric Incoming timeline metric to aggregate
- @param baseAggregatedMetric Base timeline metric
- @return Result metric after aggregation]]>
- </doc>
- </method>
- <method name="aggregateTo" return="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="incomingMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
- <param name="baseAggregatedMetric" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric"/>
- <param name="state" type="java.util.Map"/>
- <doc>
- <![CDATA[Aggregate an incoming metric to the base aggregated metric with the given
- operation state. The assumption here is baseAggregatedMetric and
- latestMetric should be single value data if not null.
- @param incomingMetric Incoming timeline metric to aggregate
- @param baseAggregatedMetric Base timeline metric
- @param state Operation state
- @return Result metric after aggregation]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This class contains the information of a metric that is related to some
- entity. Metric can either be a time series or single value.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse -->
- <class name="TimelineWriteResponse" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineWriteResponse"
- 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 TimelineWriteError} instances.
- @return a list of {@link TimelineWriteError} 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.timelineservice.TimelineWriteResponse.TimelineWriteError"/>
- <doc>
- <![CDATA[Add a single {@link TimelineWriteError} instance into the existing list.
- @param error
- a single {@link TimelineWriteError} instance]]>
- </doc>
- </method>
- <method name="addErrors"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writeErrors" type="java.util.List"/>
- <doc>
- <![CDATA[Add a list of {@link TimelineWriteError} instances into the existing list.
- @param writeErrors
- a list of {@link TimelineWriteError} instances]]>
- </doc>
- </method>
- <method name="setErrors"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="writeErrors" type="java.util.List"/>
- <doc>
- <![CDATA[Set the list to the given list of {@link TimelineWriteError} instances.
- @param writeErrors
- a list of {@link TimelineWriteError} 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.timelineservice.TimelineWriteResponse -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError -->
- <class name="TimelineWriteResponse.TimelineWriteError" extends="java.lang.Object"
- abstract="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="TimelineWriteError"
- 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="id" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity Id.
- @param id 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="type" type="java.lang.String"/>
- <doc>
- <![CDATA[Set the entity type.
- @param type 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="code" type="int"/>
- <doc>
- <![CDATA[Set the error code to the given error code.
- @param code an error code.]]>
- </doc>
- </method>
- <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 storing an
- entity.]]>
- </doc>
- </field>
- <doc>
- <![CDATA[A class that holds the error code for one entity.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.TimelineWriteResponse.TimelineWriteError -->
- <!-- start class org.apache.hadoop.yarn.api.records.timelineservice.UserEntity -->
- <class name="UserEntity" extends="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="UserEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="UserEntity" type="org.apache.hadoop.yarn.api.records.timelineservice.TimelineEntity"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This entity represents a user.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.records.timelineservice.UserEntity -->
- </package>
- <package name="org.apache.hadoop.yarn.api.resource">
- <!-- start class org.apache.hadoop.yarn.api.resource.PlacementConstraint -->
- <class name="PlacementConstraint" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="PlacementConstraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <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="getConstraintExpr" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the constraint expression of the placement constraint.
- @return the constraint expression]]>
- </doc>
- </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[{@code PlacementConstraint} represents a placement constraint for a resource
- allocation.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.resource.PlacementConstraint -->
- <!-- start class org.apache.hadoop.yarn.api.resource.PlacementConstraints -->
- <class name="PlacementConstraints" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="targetIn" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
- <doc>
- <![CDATA[Creates a constraint that requires allocations to be placed on nodes that
- satisfy all target expressions within the given scope (e.g., node or rack).
- For example, {@code targetIn(RACK, allocationTag("hbase-m"))}, allows
- allocations on nodes that belong to a rack that has at least one tag with
- value "hbase-m".
- @param scope the scope within which the target expressions should be
- satisfied
- @param targetExpressions the expressions that need to be satisfied within
- the scope
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="targetNotIn" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
- <doc>
- <![CDATA[Creates a constraint that requires allocations to be placed on nodes that
- belong to a scope (e.g., node or rack) that does not satisfy any of the
- target expressions.
- @param scope the scope within which the target expressions should not be
- true
- @param targetExpressions the expressions that need to not be true within
- the scope
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="targetNodeAttribute" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="opCode" type="org.apache.hadoop.yarn.api.records.NodeAttributeOpCode"/>
- <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
- <doc>
- <![CDATA[Creates a constraint that requires allocations to be placed on nodes that
- belong to a scope (e.g., node or rack) that satisfy any of the
- target expressions based on node attribute op code.
- @param scope the scope within which the target expressions should not be
- true
- @param opCode Node Attribute code which could be equals, not equals.
- @param targetExpressions the expressions that need to not be true within
- the scope
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="cardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="minCardinality" type="int"/>
- <param name="maxCardinality" type="int"/>
- <param name="allocationTags" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Creates a constraint that restricts the number of allocations within a
- given scope (e.g., node or rack).
- For example, {@code cardinality(NODE, 3, 10, "zk")} is satisfied on nodes
- where there are no less than 3 allocations with tag "zk" and no more than
- 10.
- @param scope the scope of the constraint
- @param minCardinality determines the minimum number of allocations within
- the scope
- @param maxCardinality determines the maximum number of allocations within
- the scope
- @param allocationTags the constraint targets allocations with these tags
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="cardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="namespace" type="java.lang.String"/>
- <param name="minCardinality" type="int"/>
- <param name="maxCardinality" type="int"/>
- <param name="allocationTags" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Similar to {@link #cardinality(String, int, int, String...)}, but let you
- attach a namespace to the given allocation tags.
- @param scope the scope of the constraint
- @param namespace the namespace of the allocation tags
- @param minCardinality determines the minimum number of allocations within
- the scope
- @param maxCardinality determines the maximum number of allocations within
- the scope
- @param allocationTags allocation tags
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="minCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="minCardinality" type="int"/>
- <param name="allocationTags" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Similar to {@link #cardinality(String, int, int, String...)}, but
- determines only the minimum cardinality (the maximum cardinality is
- unbound).
- @param scope the scope of the constraint
- @param minCardinality determines the minimum number of allocations within
- the scope
- @param allocationTags the constraint targets allocations with these tags
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="minCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="namespace" type="java.lang.String"/>
- <param name="minCardinality" type="int"/>
- <param name="allocationTags" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Similar to {@link #minCardinality(String, int, String...)}, but let you
- attach a namespace to the allocation tags.
- @param scope the scope of the constraint
- @param namespace the namespace of these tags
- @param minCardinality determines the minimum number of allocations within
- the scope
- @param allocationTags the constraint targets allocations with these tags
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="maxCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="maxCardinality" type="int"/>
- <param name="allocationTags" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Similar to {@link #cardinality(String, int, int, String...)}, but
- determines only the maximum cardinality (the minimum cardinality is 0).
- @param scope the scope of the constraint
- @param maxCardinality determines the maximum number of allocations within
- the scope
- @param allocationTags the constraint targets allocations with these tags
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="maxCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="tagNamespace" type="java.lang.String"/>
- <param name="maxCardinality" type="int"/>
- <param name="allocationTags" type="java.lang.String[]"/>
- <doc>
- <![CDATA[Similar to {@link #maxCardinality(String, int, String...)}, but let you
- specify a namespace for the tags, see supported namespaces in
- {@link AllocationTagNamespaceType}.
- @param scope the scope of the constraint
- @param tagNamespace the namespace of these tags
- @param maxCardinality determines the maximum number of allocations within
- the scope
- @param allocationTags allocation tags
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="targetCardinality" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="scope" type="java.lang.String"/>
- <param name="minCardinality" type="int"/>
- <param name="maxCardinality" type="int"/>
- <param name="targetExpressions" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TargetExpression[]"/>
- <doc>
- <![CDATA[This constraint generalizes the cardinality and target constraints.
- Consider a set of nodes N that belongs to the scope specified in the
- constraint. If the target expressions are satisfied at least minCardinality
- times and at most maxCardinality times in the node set N, then the
- constraint is satisfied.
- For example, {@code targetCardinality(RACK, 2, 10, allocationTag("zk"))},
- requires an allocation to be placed within a rack that has at least 2 and
- at most 10 other allocations with tag "zk".
- @param scope the scope of the constraint
- @param minCardinality the minimum number of times the target expressions
- have to be satisfied with the given scope
- @param maxCardinality the maximum number of times the target expressions
- have to be satisfied with the given scope
- @param targetExpressions the target expressions
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="and" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.And"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="children" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint[]"/>
- <doc>
- <![CDATA[A conjunction of constraints.
- @param children the children constraints that should all be satisfied
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="or" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.Or"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="children" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint[]"/>
- <doc>
- <![CDATA[A disjunction of constraints.
- @param children the children constraints, one of which should be satisfied
- @return the resulting placement constraint]]>
- </doc>
- </method>
- <method name="delayedOr" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.DelayedOr"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="children" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TimedPlacementConstraint[]"/>
- <doc>
- <![CDATA[Creates a composite constraint that includes a list of timed placement
- constraints. The scheduler should try to satisfy first the first timed
- child constraint within the specified time window. If this is not possible,
- it should attempt to satisfy the second, and so on.
- @param children the timed children constraints
- @return the resulting composite constraint]]>
- </doc>
- </method>
- <method name="timedClockConstraint" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TimedPlacementConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="constraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"/>
- <param name="delay" type="long"/>
- <param name="timeUnit" type="java.util.concurrent.TimeUnit"/>
- <doc>
- <![CDATA[Creates a placement constraint that has to be satisfied within a time
- window.
- @param constraint the placement constraint
- @param delay the length of the time window within which the constraint has
- to be satisfied
- @param timeUnit the unit of time of the time window
- @return the resulting timed placement constraint]]>
- </doc>
- </method>
- <method name="timedOpportunitiesConstraint" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.TimedPlacementConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="constraint" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"/>
- <param name="delay" type="long"/>
- <doc>
- <![CDATA[Creates a placement constraint that has to be satisfied within a number of
- placement opportunities (invocations of the scheduler).
- @param constraint the placement constraint
- @param delay the number of scheduling opportunities within which the
- constraint has to be satisfied
- @return the resulting timed placement constraint]]>
- </doc>
- </method>
- <method name="build" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="constraintExpr" type="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"/>
- <doc>
- <![CDATA[Creates a {@link PlacementConstraint} given a constraint expression.
- @param constraintExpr the constraint expression
- @return the placement constraint]]>
- </doc>
- </method>
- <field name="NODE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RACK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NODE_PARTITION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[This class contains various static methods for the applications to create
- placement constraints (see also {@link PlacementConstraint}).]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.api.resource.PlacementConstraints -->
- </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="isAclEnabled" 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>
- <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>
- <method name="shouldRMFailFast" 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>
- <method name="isDistSchedulingEnabled" 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>
- <method name="isOpportunisticContainerAllocationEnabled" 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>
- <method name="timelineServiceEnabled" 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"/>
- <doc>
- <![CDATA[Returns whether the timeline service is enabled via configuration.
- @param conf the configuration
- @return whether the timeline service is enabled.]]>
- </doc>
- </method>
- <method name="getTimelineServiceVersion" return="float"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="conf" type="org.apache.hadoop.conf.Configuration"/>
- <doc>
- <![CDATA[Returns the timeline service version. It does not check whether the
- timeline service itself is enabled.
- @param conf the configuration
- @return the timeline service version as a float.]]>
- </doc>
- </method>
- <method name="timelineServiceV2Enabled" 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"/>
- <doc>
- <![CDATA[Returns whether the timeline service v.2 is enabled via configuration.
- @param conf the configuration
- @return whether the timeline service v.2 is enabled. V.2 refers to a
- version greater than equal to 2 but smaller than 3.]]>
- </doc>
- </method>
- <method name="timelineServiceV1Enabled" 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"/>
- <doc>
- <![CDATA[Returns whether the timeline service v.1 is enabled via configuration.
- @param conf the configuration
- @return whether the timeline service v.1 is enabled. V.1 refers to a
- version greater than equal to 1 but smaller than 2.]]>
- </doc>
- </method>
- <method name="timelineServiceV15Enabled" 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"/>
- <doc>
- <![CDATA[Returns whether the timeline service v.1,5 is enabled via configuration.
- @param conf the configuration
- @return whether the timeline service v.1.5 is enabled. V.1.5 refers to a
- version equal to 1.5.]]>
- </doc>
- </method>
- <method name="systemMetricsPublisherEnabled" 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"/>
- <doc>
- <![CDATA[Returns whether the system publisher is enabled.
- @param conf the configuration
- @return whether the system publisher is enabled.]]>
- </doc>
- </method>
- <method name="numaAwarenessEnabled" 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"/>
- <doc>
- <![CDATA[Returns whether the NUMA awareness is enabled.
- @param conf the configuration
- @return whether the NUMA awareness is enabled.]]>
- </doc>
- </method>
- <method name="main"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="args" type="java.lang.String[]"/>
- <exception name="Exception" type="java.lang.Exception"/>
- </method>
- <field name="DR_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <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="RESOURCE_TYPES_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NODE_RESOURCES_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="NM_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="RESOURCE_TYPES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RESOURCES_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="NM_LOG_CONTAINER_DEBUG_INFO" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_LOG_CONTAINER_DEBUG_INFO" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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 serializable 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="DEFAULT_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_EPOCH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_EPOCH" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_EPOCH_RANGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The epoch range before wrap around. 0 disables wrap around]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_EPOCH_RANGE" type="long"
- 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_APPLICATION_MAX_TAGS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max number of application tags.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_APPLICATION_MAX_TAGS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_APPLICATION_MAX_TAG_LENGTH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max length of each application tag.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_APPLICATION_MAX_TAG_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_APPLICATION_MASTER_SERVICE_PROCESSORS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_AUTO_UPDATE_CONTAINERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_AUTO_UPDATE_CONTAINERS" type="boolean"
- 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_AMLAUNCHER_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 launch/cleanup AM.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_AMLAUNCHER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODEMANAGER_CONNECT_RETRIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Retry times to connect with NM.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NODEMANAGER_CONNECT_RETRIES" 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[Minimum 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="QUEUE_PLACEMENT_RULES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Configured scheduler queue placement rules.]]>
- </doc>
- </field>
- <field name="USER_GROUP_PLACEMENT_RULE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[UserGroupMappingPlacementRule configuration string.]]>
- </doc>
- </field>
- <field name="APP_NAME_PLACEMENT_RULE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_WEBAPP_UI_ACTIONS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable Resource Manager webapp ui actions]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_WEBAPP_UI_ACTIONS_ENABLED" 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_RESERVATION_SYSTEM_MAX_PERIODICITY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The maximum periodicity for the Reservation System.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_RESERVATION_SYSTEM_MAX_PERIODICITY" 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="YARN_WEBAPP_UI2_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable YARN WebApp V2.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_WEBAPP_UI2_ENABLE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_WEBAPP_UI2_WARFILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_API_SERVICES_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_YARN_API_SYSTEM_SERVICES_CLASS" 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_RESERVATION_ACL_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Are reservation acls enabled.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_RESERVATION_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="OPPORTUNISTIC_CONTAINER_ALLOCATION_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Setting that controls whether opportunistic container allocation
- is enabled or not.]]>
- </doc>
- </field>
- <field name="DEFAULT_OPPORTUNISTIC_CONTAINER_ALLOCATION_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="OPP_CONTAINER_MAX_ALLOCATIONS_PER_AM_HEARTBEAT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Maximum number of opportunistic containers to be allocated in
- AM heartbeat.]]>
- </doc>
- </field>
- <field name="DEFAULT_OPP_CONTAINER_MAX_ALLOCATIONS_PER_AM_HEARTBEAT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="OPP_CONTAINER_ALLOCATION_NODES_NUMBER_USED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Number of nodes to be used by the Opportunistic Container allocator for
- dispatching containers during container allocation.]]>
- </doc>
- </field>
- <field name="DEFAULT_OPP_CONTAINER_ALLOCATION_NODES_NUMBER_USED" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_QUEUING_SORTING_NODES_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Frequency for computing least loaded NMs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_QUEUING_SORTING_NODES_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_QUEUING_LOAD_COMPARATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Comparator for determining node load for scheduling of opportunistic
- containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_QUEUING_LOAD_COMPARATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_QUEUING_LIMIT_STDEV" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Value of standard deviation used for calculation of queue limit
- thresholds.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_QUEUING_LIMIT_STDEV" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_QUEUING_MIN_QUEUE_LENGTH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Min length of container queue at NodeManager. This is a cluster-wide
- configuration that acts as the lower-bound of optimal queue length
- calculated by the NodeQueueLoadMonitor]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_QUEUING_MIN_QUEUE_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_QUEUING_MAX_QUEUE_LENGTH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max length of container queue at NodeManager. This is a cluster-wide
- configuration that acts as the upper-bound of optimal queue length
- calculated by the NodeQueueLoadMonitor]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_QUEUING_MAX_QUEUE_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_QUEUING_MIN_QUEUE_WAIT_TIME_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Min queue wait time for a container at a NodeManager.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_QUEUING_MIN_QUEUE_WAIT_TIME_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_QUEUING_MAX_QUEUE_WAIT_TIME_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max queue wait time for a container queue at a NodeManager.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_QUEUING_MAX_QUEUE_WAIT_TIME_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_INTERMEDIATE_DATA_ENCRYPTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/disable intermediate-data encryption at YARN level. For now, this
- only is used by the FileSystemRMStateStore to setup right file-system
- security attributes.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_INTERMEDIATE_DATA_ENCRYPTION" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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 for
- an application, if unset by user.]]>
- </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="GLOBAL_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="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_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable cross origin (CORS) support.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_WEBAPP_ENABLE_CORS_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_SUBMISSION_PREPROCESSOR_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable submission pre-processor.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SUBMISSION_PREPROCESSOR_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 hosts for the submission processor to handle.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SUBMISSION_PREPROCESSOR_REFRESH_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Submission processor refresh interval.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SUBMISSION_PREPROCESSOR_REFRESH_INTERVAL_MS" type="int"
- 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_NM_REGISTRATION_IP_HOSTNAME_CHECK_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Check IP and hostname resolution during nodemanager registration.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NM_REGISTRATION_IP_HOSTNAME_CHECK_KEY" type="boolean"
- 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="RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specify which handler will be used to process PlacementConstraints.
- For details on PlacementConstraints, please refer to
- {@link org.apache.hadoop.yarn.api.resource.PlacementConstraint}]]>
- </doc>
- </field>
- <field name="DISABLED_RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This handler rejects all allocate calls made by an application, if they
- contain a {@link org.apache.hadoop.yarn.api.records.SchedulingRequest}.]]>
- </doc>
- </field>
- <field name="PROCESSOR_RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Using this handler, the placement of containers with constraints is
- determined as a pre-processing step before the capacity or the fair
- scheduler is called. Once the placement is decided, the capacity/fair
- scheduler is invoked to perform the actual allocation. The advantage of
- this approach is that it supports all constraint types (affinity,
- anti-affinity, cardinality). Moreover, it considers multiple containers at
- a time, which allows to satisfy more constraints than a container-at-a-time
- approach can achieve. As it sits outside the main scheduler, it can be used
- by both the capacity and fair schedulers. Note that at the moment it does
- not account for task priorities within an application, given that such
- priorities might be conflicting with the placement constraints.]]>
- </doc>
- </field>
- <field name="SCHEDULER_RM_PLACEMENT_CONSTRAINTS_HANDLER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Using this handler, containers with constraints will be placed by the main
- scheduler. If the configured RM scheduler
- <pre>yarn.resourcemanager.scheduler.class</pre>
- cannot handle placement constraints, the corresponding SchedulingRequests
- will be rejected. As of now, only the capacity scheduler supports
- SchedulingRequests. In particular, it currently supports anti-affinity
- constraints (no affinity or cardinality) and places one container at a
- time. The advantage of this handler compared to the placement-processor is
- that it follows the same ordering rules for queues (sorted by utilization,
- priority) and apps (sorted by FIFO/fairness/priority) as the ones followed
- by the main scheduler.]]>
- </doc>
- </field>
- <field name="RM_PLACEMENT_CONSTRAINTS_ALGORITHM_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Placement Algorithm.]]>
- </doc>
- </field>
- <field name="RM_PLACEMENT_CONSTRAINTS_ALGORITHM_ITERATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Used for BasicPlacementAlgorithm - default SERIAL.]]>
- </doc>
- </field>
- <field name="RM_PLACEMENT_CONSTRAINTS_RETRY_ATTEMPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_PLACEMENT_CONSTRAINTS_RETRY_ATTEMPTS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PLACEMENT_CONSTRAINTS_ALGORITHM_POOL_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_PLACEMENT_CONSTRAINTS_ALGORITHM_POOL_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PLACEMENT_CONSTRAINTS_SCHEDULER_POOL_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_PLACEMENT_CONSTRAINTS_SCHEDULER_POOL_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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_NM_HEARTBEAT_INTERVAL_SCALING_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable Heartbeat Interval Scaling based on cpu utilization.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_SCALING_ENABLE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NM_HEARTBEAT_INTERVAL_MIN_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MIN_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NM_HEARTBEAT_INTERVAL_MAX_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_MAX_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NM_HEARTBEAT_INTERVAL_SPEEDUP_FACTOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_SPEEDUP_FACTOR" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NM_HEARTBEAT_INTERVAL_SLOWDOWN_FACTOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_NM_HEARTBEAT_INTERVAL_SLOWDOWN_FACTOR" type="float"
- 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. This configuration setting is for ATS V1.
- This is now deprecated in favor of SYSTEM_METRICS_PUBLISHER_ENABLED.]]>
- </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="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 and NM. This configuration setting is for
- ATS v2.]]>
- </doc>
- </field>
- <field name="DEFAULT_SYSTEM_METRICS_PUBLISHER_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PUBLISH_CONTAINER_EVENTS_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 container events are published to
- the timeline service or not by RM. This configuration setting is for ATS
- V2]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_PUBLISH_CONTAINER_EVENTS_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="RM_TIMELINE_SERVER_V1_PUBLISHER_DISPATCHER_BATCH_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_TIMELINE_SERVER_V1_PUBLISHER_DISPATCHER_BATCH_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_TIMELINE_SERVER_V1_PUBLISHER_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_TIMELINE_SERVER_V1_PUBLISHER_INTERVAL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_TIMELINE_SERVER_V1_PUBLISHER_BATCH_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_TIMELINE_SERVER_V1_PUBLISHER_BATCH_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_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="RM_DELEGATION_KEY_UPDATE_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_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="RM_DELEGATION_TOKEN_RENEW_INTERVAL_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_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="RM_DELEGATION_TOKEN_MAX_LIFETIME_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_TOKEN_MAX_CONF_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_DELEGATION_TOKEN_MAX_CONF_SIZE_BYTES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DELEGATION_TOKEN_ALWAYS_CANCEL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_DELEGATION_TOKEN_ALWAYS_CANCEL" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DT_RENEWER_THREAD_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_DT_RENEWER_THREAD_TIMEOUT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DT_RENEWER_THREAD_RETRY_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_DT_RENEWER_THREAD_RETRY_INTERVAL" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DT_RENEWER_THREAD_RETRY_MAX_ATTEMPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_DT_RENEWER_THREAD_RETRY_MAX_ATTEMPTS" type="int"
- 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="YARN_FAIL_FAST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_YARN_FAIL_FAST" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_FAIL_FAST" type="java.lang.String"
- 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_ZNODE_SIZE_LIMIT_BYTES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Zookeeper znode limit]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_ZK_ZNODE_SIZE_LIMIT_BYTES" 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="int"
- 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="ZK_APPID_NODE_SPLIT_INDEX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ZK_APPID_NODE_SPLIT_INDEX" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ZK_DELEGATION_TOKEN_NODE_SPLIT_INDEX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Index at which the RM Delegation Token ids will be split so that the
- delegation token znodes stored in the zookeeper RM state store will be
- stored as two different znodes (parent-child).]]>
- </doc>
- </field>
- <field name="DEFAULT_ZK_DELEGATION_TOKEN_NODE_SPLIT_INDEX" 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="SCHEDULER_CONFIGURATION_STORE_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FILE_CONFIGURATION_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MEMORY_CONFIGURATION_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_CONFIGURATION_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ZK_CONFIGURATION_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LEVELDB_CONFIGURATION_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CONFIGURATION_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDCONF_STORE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDCONF_LEVELDB_COMPACTION_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SCHEDCONF_LEVELDB_COMPACTION_INTERVAL_SECS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDCONF_MAX_LOGS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SCHEDCONF_LEVELDB_MAX_LOGS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_SCHEDCONF_ZK_MAX_LOGS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCHEDULER_CONFIGURATION_FS_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCHEDULER_CONFIGURATION_FS_MAX_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCHEDULER_CONFIGURATION_FS_MAX_VERSION" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDCONF_STORE_ZK_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 ZKConfigurationStore will create znodes.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_SCHEDCONF_STORE_ZK_PARENT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_SCHEDULER_MUTATION_ACL_POLICY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_AUTHORIZATION_PROVIDER" 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="This property should never be set to {@code false}.">
- <doc>
- <![CDATA[This property controls whether {@link ActiveStandbyElector} leader
- election should be used when {@link #CURATOR_LEADER_ELECTOR} is
- {@code false}.
- @deprecated This property should never be set to {@code false}.]]>
- </doc>
- </field>
- <field name="DEFAULT_AUTO_FAILOVER_EMBEDDED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="The {@link #AUTO_FAILOVER_EMBEDDED} property is deprecated.">
- <doc>
- <![CDATA[The default value for {@link #AUTO_FAILOVER_EMBEDDED}.
- @deprecated The {@link #AUTO_FAILOVER_EMBEDDED} property is deprecated.]]>
- </doc>
- </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_NO_HA_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_NO_HA_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_HA_FC_ELECTOR_ZK_RETRIES_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[number of zookeeper operation retry times in ActiveStandbyElector]]>
- </doc>
- </field>
- <field name="CURATOR_LEADER_ELECTOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="Eventually, we want to default to the curator-based
- implementation and remove the {@link ActiveStandbyElector} based
- implementation. We should remove this config then.">
- <doc>
- <![CDATA[Whether to use the Curator-based elector for leader election.
- @deprecated Eventually, we want to default to the curator-based
- implementation and remove the {@link ActiveStandbyElector} based
- implementation. We should remove this config then.]]>
- </doc>
- </field>
- <field name="DEFAULT_CURATOR_LEADER_ELECTOR_ENABLED" type="boolean"
- 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_NUM_RETRIES" 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_NUM_RETRIES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FS_RM_STATE_STORE_RETRY_INTERVAL_MS" 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_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_LEVELDB_STORE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The time in seconds between full compactions of the leveldb database.
- Setting the interval to zero disables the full compaction cycles.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_LEVELDB_COMPACTION_INTERVAL_SECS" type="long"
- 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. By default equals
- to {@link #DEFAULT_RM_MAX_COMPLETED_APPLICATIONS}.]]>
- </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 value of {@link #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="This default value is ignored and will be removed in a future
- release. The default value of
- {@code yarn.resourcemanager.state-store.max-completed-applications} is the
- value of {@link #RM_MAX_COMPLETED_APPLICATIONS}.">
- <doc>
- <![CDATA[The default value for
- {@code yarn.resourcemanager.state-store.max-completed-applications}.
- @deprecated This default value is ignored and will be removed in a future
- release. The default value of
- {@code yarn.resourcemanager.state-store.max-completed-applications} is the
- value of {@link #RM_MAX_COMPLETED_APPLICATIONS}.]]>
- </doc>
- </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_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeout(msec) for an untracked node to remain in shutdown or decommissioned
- state.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NODEMANAGER_UNTRACKED_REMOVAL_TIMEOUT_MSEC" type="int"
- 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="RM_RESOURCE_PROFILES_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/disable resource profiles.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_RESOURCE_PROFILES_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_RESOURCE_PROFILES_SOURCE_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[File containing resource profiles.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_RESOURCE_PROFILES_SOURCE_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_CLIENT_LOAD_RESOURCETYPES_FROM_SERVER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/disable loading resource-types.xml at client side.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_CLIENT_LOAD_RESOURCETYPES_FROM_SERVER" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODE_GRACEFUL_DECOMMISSION_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeout in seconds for YARN node graceful decommission.
- This is the maximal time to wait for running containers and applications
- to complete before transition a DECOMMISSIONING node into DECOMMISSIONED.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NODE_GRACEFUL_DECOMMISSION_TIMEOUT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_DECOMMISSIONING_NODES_WATCHER_POLL_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Period in seconds of the poll timer task inside DecommissioningNodesWatcher
- to identify and take care of DECOMMISSIONING nodes missing regular heart beat.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_DECOMMISSIONING_NODES_WATCHER_POLL_INTERVAL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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_OPPORTUNISTIC_CONTAINERS_MAX_QUEUE_LENGTH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max Queue length of <code>OPPORTUNISTIC</code> containers on the NM.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_OPPORTUNISTIC_CONTAINERS_MAX_QUEUE_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DIST_SCHEDULING_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Setting that controls whether distributed scheduling is enabled or not.]]>
- </doc>
- </field>
- <field name="DEFAULT_DIST_SCHEDULING_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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_ADMIN_FORCE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[PATH components that will be prepended to the user's path.
- If this is defined and the user does not define PATH, NM will also
- append ":$PATH" to prevent this from eclipsing the PATH defined in
- the container. This feature is only available for Linux.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_ADMIN_FORCE_PATH" 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 for 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_STATE_TRANSITION_LISTENERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[List of container state transition listeners.]]>
- </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_COLLECTOR_SERVICE_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_COLLECTOR_SERVICE_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_CONTAINER_EXECUTOR_EXIT_FILE_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_CONTAINER_EXECUTOR_EXIT_FILE_TIMEOUT" 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_COLLECTOR_SERVICE_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Address where the collector service IPC is.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_COLLECTOR_SERVICE_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_COLLECTOR_SERVICE_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PUBLISH_CONTAINER_EVENTS_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 container events are published to
- the timeline service or not by NM. This configuration setting is for ATS
- V2]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PUBLISH_CONTAINER_EVENTS_ENABLED" type="boolean"
- 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_LOG_AGGREGATION_THREAD_POOL_SIZE" 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 log aggregation in node manager.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_AGGREGATION_THREAD_POOL_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_DEFAULT_CONTAINER_EXECUTOR_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default permissions for container logs.]]>
- </doc>
- </field>
- <field name="NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_DEFAULT_CONTAINER_EXECUTOR_LOG_DIRS_PERMISSIONS_DEFAULT" 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="DISK_VALIDATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Disk Validator.]]>
- </doc>
- </field>
- <field name="DEFAULT_DISK_VALIDATOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_DIAGNOSTICS_MAXIMUM_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Maximum size of contain's diagnostics to keep for relaunching container
- case.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_DIAGNOSTICS_MAXIMUM_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_RETRY_MINIMUM_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Minimum container restart interval.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_RETRY_MINIMUM_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_QUEUING_USE_PAUSE_FOR_PREEMPTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Use container pause as the preemption policy over kill in the container
- queue at a NodeManager.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_QUEUING_USE_PAUSE_FOR_PREEMPTION" type="boolean"
- 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="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The expiry interval for node IP caching. -1 disables the caching]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_NODE_IP_CACHE_EXPIRY_INTERVAL_SECS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How many diagnostics/failure messages can be saved in RM for
- log aggregation. It also defines the number of diagnostics/failure
- messages can be shown in log aggregation web ui.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_MAX_LOG_AGGREGATION_DIAGNOSTICS_IN_MEMORY" type="int"
- transient="false" volatile="false"
- static="true" final="true" 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_FILE_FORMATS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG_AGGREGATION_FILE_CONTROLLER_FMT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG_AGGREGATION_REMOTE_APP_LOG_DIR_FMT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LOG_AGGREGATION_REMOTE_APP_LOG_DIR_SUFFIX_FMT" type="java.lang.String"
- 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_DEBUG_FILESIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_LOG_AGGREGATION_DEBUG_FILESIZE" 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 {@literal <=} 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="LOG_AGGREGATION_STATUS_TIME_OUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[How long for ResourceManager to wait for NodeManager to report its
- log aggregation status. If waiting time of which the log aggregation status
- is reported from NodeManager exceeds the configured value, RM will report
- log aggregation status for this NodeManager as TIME_OUT.
- This configuration will be used in NodeManager as well to decide
- whether and when to delete the cached log aggregation status.]]>
- </doc>
- </field>
- <field name="DEFAULT_LOG_AGGREGATION_STATUS_TIME_OUT_MS" 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="MIN_LOG_ROLLING_INTERVAL_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The allowed hard minimum limit for {@link
- YarnConfiguration#NM_LOG_AGGREGATION_ROLL_MONITORING_INTERVAL_SECONDS}.]]>
- </doc>
- </field>
- <field name="MIN_LOG_ROLLING_INTERVAL_SECONDS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_AGGREGATION_NUM_LOG_FILES_SIZE_PER_APP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Define how many aggregated log files per application per NM we can have
- in remote file system.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LOG_AGGREGATION_NUM_LOG_FILES_SIZE_PER_APP" type="int"
- 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 below location.
- NM_REMOTE_APP_LOG_DIR/${user}/bucket_{NM_REMOTE_APP_LOG_DIR_SUFFIX}
- /${bucketDir}/${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="NM_REMOTE_APP_LOG_DIR_INCLUDE_OLDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies whether Older Application Log Directory is included.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_REMOTE_APP_LOG_DIR_INCLUDE_OLDER" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_REMOTE_APP_LOG_DIR_GROUPNAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies the group of the aggregated log directory.]]>
- </doc>
- </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_LOG_SERVER_WEBSERVICE_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 MB 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_SYSTEM_RESERVED_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 MB that has been reserved for non-yarn use.]]>
- </doc>
- </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 virtual 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_ELASTIC_MEMORY_CONTROL_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies whether to do memory check on overall usage.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_ELASTIC_MEMORY_CONTROL_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_ELASTIC_MEMORY_CONTROL_OOM_HANDLER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies the OOM handler code.]]>
- </doc>
- </field>
- <field name="NM_ELASTIC_MEMORY_CONTROL_OOM_LISTENER_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The path to the OOM listener.]]>
- </doc>
- </field>
- <field name="NM_ELASTIC_MEMORY_CONTROL_OOM_TIMEOUT_SEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Maximum time in seconds to resolve an OOM situation.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_ELASTIC_MEMORY_CONTROL_OOM_TIMEOUT_SEC" type="java.lang.Integer"
- 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_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Count logical processors(like hyperthreads) as cores.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_COUNT_LOGICAL_PROCESSORS_AS_CORES" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PCORES_VCORES_MULTIPLIER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Multiplier to convert physical cores to vcores.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PCORES_VCORES_MULTIPLIER" type="float"
- 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_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable or disable node hardware capability detection.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_ENABLE_HARDWARE_CAPABILITY_DETECTION" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_MEMORY_RESOURCE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_MEMORY_RESOURCE_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_MEMORY_RESOURCE_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_MEMORY_RESOURCE_ENFORCED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_MEMORY_RESOURCE_ENFORCED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SWAPPINESS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_MEMORY_RESOURCE_CGROUPS_SOFT_LIMIT_PERCENTAGE" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CPU_RESOURCE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CPU_RESOURCE_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable cpu isolation.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CPU_RESOURCE_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_DISK_RESOURCE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prefix for disk configurations. Work in progress: This configuration
- parameter may be changed/removed in the future.]]>
- </doc>
- </field>
- <field name="NM_DISK_RESOURCE_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This setting controls if resource handling for disk operations is enabled.
- Work in progress: This configuration parameter may be changed/removed in
- the future]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DISK_RESOURCE_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Disk as a resource is disabled by default.]]>
- </doc>
- </field>
- <field name="NM_NETWORK_RESOURCE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NETWORK_RESOURCE_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This setting controls if resource handling for network bandwidth is
- enabled. Work in progress: This configuration parameter may be
- changed/removed in the future]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NETWORK_RESOURCE_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Network as a resource is disabled by default.]]>
- </doc>
- </field>
- <field name="NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies the interface to be used for applying network throttling rules.
- Work in progress: This configuration parameter may be changed/removed in
- the future]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NETWORK_RESOURCE_INTERFACE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies the total available outbound bandwidth on the node. Work in
- progress: This configuration parameter may be changed/removed in the future]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_YARN_MBIT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies the total outbound bandwidth available to YARN containers.
- defaults to NM_NETWORK_RESOURCE_OUTBOUND_BANDWIDTH_MBIT if not specified.
- Work in progress: This configuration parameter may be changed/removed in
- the future]]>
- </doc>
- </field>
- <field name="NM_RESOURCE_PLUGINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prefix for computation resources, example of computation resources like
- GPU / FPGA / TPU, etc.]]>
- </doc>
- </field>
- <field name="NM_RESOURCE_PLUGINS_FAIL_FAST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies whether the initialization of the Node Manager should continue
- if a certain device (GPU, FPGA, etc) was not found in the system. If set
- to "true", then an exception will be thrown if a device is missing or
- an error occurred during discovery.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RESOURCE_PLUGINS_FAIL_FAST" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PLUGGABLE_DEVICE_FRAMEWORK_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This setting controls if pluggable device plugin framework is enabled.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_PLUGGABLE_DEVICE_FRAMEWORK_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The pluggable device plugin framework is disabled by default]]>
- </doc>
- </field>
- <field name="NM_PLUGGABLE_DEVICE_FRAMEWORK_DEVICE_CLASSES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This setting contains vendor plugin class names for
- device plugin framework to load. Split by comma]]>
- </doc>
- </field>
- <field name="NM_GPU_RESOURCE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prefix for gpu configurations. Work in progress: This configuration
- parameter may be changed/removed in the future.]]>
- </doc>
- </field>
- <field name="NM_GPU_ALLOWED_DEVICES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AUTOMATICALLY_DISCOVER_GPU_DEVICES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_GPU_PATH_TO_EXEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This setting controls where to how to invoke GPU binaries]]>
- </doc>
- </field>
- <field name="NM_GPU_DOCKER_PLUGIN_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Settings to control which implementation of docker plugin for GPU will be
- used.
- By default uses NVIDIA docker v1.]]>
- </doc>
- </field>
- <field name="NVIDIA_DOCKER_V1" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NVIDIA_DOCKER_V2" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_GPU_DOCKER_PLUGIN_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NVIDIA_DOCKER_PLUGIN_V1_ENDPOINT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This setting controls end point of nvidia-docker-v1 plugin.]]>
- </doc>
- </field>
- <field name="DEFAULT_NVIDIA_DOCKER_PLUGIN_V1_ENDPOINT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_FPGA_RESOURCE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prefix for FPGA configurations. Work in progress: This configuration
- parameter may be changed/removed in the future.]]>
- </doc>
- </field>
- <field name="NM_FPGA_ALLOWED_DEVICES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_FPGA_PATH_TO_EXEC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_FPGA_VENDOR_PLUGIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_FPGA_VENDOR_PLUGIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_FPGA_DEVICE_DISCOVERY_SCRIPT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_FPGA_AVAILABLE_DEVICES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NETWORK_TAG_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NETWORK_TAG_HANDLER_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_NETWORK_TAG_HANDLER_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NETWORK_TAG_MAPPING_MANAGER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NETWORK_TAG_MAPPING_FILE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_NETWORK_RESOURCE_TAG_MAPPING_FILE_PATH" type="java.lang.String"
- 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_WEBAPP_ENABLE_CORS_FILTER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/disable CORS filter.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_WEBAPP_ENABLE_CORS_FILTER" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RESOURCE_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 resource in a node.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RESOURCE_MON_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_MONITOR_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_CONTAINER_MONITOR_ENABLED" type="boolean"
- 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_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 current resource utilization.]]>
- </doc>
- </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="APPLICATION_TAG_BASED_PLACEMENT_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_APPLICATION_TAG_BASED_PLACEMENT_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APPLICATION_TAG_BASED_PLACEMENT_USER_WHITELIST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_LOG_MONITOR_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable switch for container log monitoring.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_LOG_MONITOR_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_LOG_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 logs generated by containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_LOG_MON_INTERVAL_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_LOG_DIR_SIZE_LIMIT_BYTES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The disk space limit for a single container log directory.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_LOG_DIR_SIZE_LIMIT_BYTES" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_LOG_TOTAL_SIZE_LIMIT_BYTES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The disk space limit for all of a container's logs.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_LOG_TOTAL_SIZE_LIMIT_BYTES" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_METRICS_ENABLE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/disable container metrics.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_METRICS_ENABLE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_METRICS_PERIOD_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Container metrics flush period. -1 for flush on completion.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_METRICS_PERIOD_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The delay time ms to unregister container metrics after completion.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_CONTAINER_METRICS_UNREGISTER_DELAY_MS" type="int"
- 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.
- This applies when disk-utilization-threshold.enabled is true.]]>
- </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_DISK_UTILIZATION_THRESHOLD_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/Disable the disk utilisation percentage
- threshold for disk health checker.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DISK_UTILIZATION_THRESHOLD_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WM_LOW_PER_DISK_UTILIZATION_PERCENTAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The low threshold percentage of disk space used when an offline disk is
- marked as online. Values can range from 0.0 to 100.0. The value shouldn't
- be more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE. If its value is
- more than NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE or not set, it will be
- set to the same value as NM_MAX_PER_DISK_UTILIZATION_PERCENTAGE.
- This applies to nm-local-dirs and nm-log-dirs.]]>
- </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.
- This applies when disk-free-space-threshold.enabled is true.]]>
- </doc>
- </field>
- <field name="NM_DISK_FREE_SPACE_THRESHOLD_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Enable/Disable the minimum disk free
- space threshold for disk health checker.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DISK_FREE_SPACE_THRESHOLD_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WM_HIGH_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 an offline
- disk for it to be marked as online. The value should not be less
- than NM_MIN_PER_DISK_FREE_SPACE_MB. If its value is less than
- NM_MIN_PER_DISK_FREE_SPACE_MB or is not set, it will be set to the
- same value as NM_MIN_PER_DISK_FREE_SPACE_MB.
- 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_SCRIPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The health checker scripts.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_HEALTH_CHECK_SCRIPTS" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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_RUN_BEFORE_STARTUP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether or not to run the node health script before the NM
- starts up.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_HEALTH_CHECK_RUN_BEFORE_STARTUP" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_HEALTH_CHECK_TIMEOUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Health check time out period for all scripts.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_HEALTH_CHECK_TIMEOUT_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_TEMPLATE" 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="NM_HEALTH_CHECK_SCRIPT_PATH_TEMPLATE" 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_TEMPLATE" 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_HEALTH_CHECK_SCRIPT_INTERVAL_MS_TEMPLATE" 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="NM_CONTAINER_LOCALIZER_JAVA_OPTS_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The JVM options used on forking ContainerLocalizer process
- by container executor.]]>
- </doc>
- </field>
- <field name="NM_CONTAINER_LOCALIZER_JAVA_OPTS_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_LOCALIZER_LOG_LEVEL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The log level of container localizer process.]]>
- </doc>
- </field>
- <field name="NM_CONTAINER_LOCALIZER_LOG_LEVEL_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="LINUX_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prefix for runtime configuration constants.]]>
- </doc>
- </field>
- <field name="LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Comma separated list of runtimes that are allowed when using
- LinuxContainerExecutor. The standard values are:
- <ul>
- <li>default</li>
- <li>docker</li>
- <li>javasandbox</li>
- <li>runc</li>
- </ul>]]>
- </doc>
- </field>
- <field name="LINUX_CONTAINER_RUNTIME_CLASS_FMT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_LINUX_CONTAINER_RUNTIME_ALLOWED_RUNTIMES" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default list of allowed runtimes when using LinuxContainerExecutor.]]>
- </doc>
- </field>
- <field name="LINUX_CONTAINER_RUNTIME_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default runtime to be used.]]>
- </doc>
- </field>
- <field name="RUNC_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RUNC_IMAGE_TAG_TO_MANIFEST_PLUGIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The runc image tag to manifest plugin class that should be used.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_IMAGE_TAG_TO_MANIFEST_PLUGIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default runc image tag to manifest plugin class.]]>
- </doc>
- </field>
- <field name="NM_RUNC_MANIFEST_TO_RESOURCES_PLUGIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The runc manifest to resources plugin class that should be used.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_MANIFEST_TO_RESOURCES_PLUGIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default runc manifest to resources plugin plugin class.]]>
- </doc>
- </field>
- <field name="NM_RUNC_IMAGE_TOPLEVEL_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The HDFS location under which the oci image manifests, layers,
- and configs directories exist.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_IMAGE_TOPLEVEL_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default HDFS location under which the oci image manifests, layers,
- and configs directories exist.]]>
- </doc>
- </field>
- <field name="NM_RUNC_LAYER_MOUNTS_TO_KEEP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Target count of layer mounts that we should keep on disk at one time.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_LAYER_MOUNTS_TO_KEEP" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_REAP_RUNC_LAYER_MOUNTS_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The interval in seconds between executions of reaping layer mounts.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_REAP_RUNC_LAYER_MOUNTS_INTERVAL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RUNC_IMAGE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default runc image to be used.]]>
- </doc>
- </field>
- <field name="NM_RUNC_ALLOW_PRIVILEGED_CONTAINERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Allow privileged containers. Use with extreme care.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_ALLOW_PRIVILEGED_CONTAINERS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Privileged containers are disabled by default.]]>
- </doc>
- </field>
- <field name="NM_RUNC_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The set of networks allowed when launching containers using the
- RuncContainerRuntime.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default set of networks allowed when launching containers using the
- RuncContainerRuntime.]]>
- </doc>
- </field>
- <field name="NM_RUNC_ALLOWED_CONTAINER_RUNTIMES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The set of runtimes allowed when launching containers using the
- RuncContainerRuntime.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_ALLOWED_CONTAINER_RUNTIMES" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default set of runtimes allowed when launching containers using the
- RuncContainerRuntime.]]>
- </doc>
- </field>
- <field name="NM_RUNC_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ACL list for users allowed to run privileged containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default list for users allowed to run privileged containers is empty.]]>
- </doc>
- </field>
- <field name="NM_RUNC_ALLOW_HOST_PID_NAMESPACE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Allow host pid namespace for containers. Use with care.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_ALLOW_HOST_PID_NAMESPACE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Host pid namespace for containers is disabled by default.]]>
- </doc>
- </field>
- <field name="NM_RUNC_DEFAULT_RO_MOUNTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default list of read-only mounts to be bind-mounted into all
- runC containers that use RuncContainerRuntime.]]>
- </doc>
- </field>
- <field name="NM_RUNC_DEFAULT_RW_MOUNTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default list of read-write mounts to be bind-mounted into all
- runC containers that use RuncContainerRuntime.]]>
- </doc>
- </field>
- <field name="NM_RUNC_SECCOMP_PROFILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Path to the seccomp profile to use with Runc containers.]]>
- </doc>
- </field>
- <field name="NM_HDFS_RUNC_IMAGE_TAG_TO_HASH_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The HDFS location where the runC image tag to hash file exists.]]>
- </doc>
- </field>
- <field name="NM_LOCAL_RUNC_IMAGE_TAG_TO_HASH_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The local file system location where the runC image tag to hash file exists.]]>
- </doc>
- </field>
- <field name="NM_RUNC_CACHE_REFRESH_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The interval in seconds between refreshing the hdfs image tag to
- hash cache.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_CACHE_REFRESH_INTERVAL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default interval in seconds between refreshing the hdfs image tag to
- hash cache.]]>
- </doc>
- </field>
- <field name="NM_RUNC_NUM_MANIFESTS_TO_CACHE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of manifests to cache in the image tag to hash cache.]]>
- </doc>
- </field>
- <field name="DEFAULT_NUM_MANIFESTS_TO_CACHE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default number of manifests to cache in the image tag to hash cache.]]>
- </doc>
- </field>
- <field name="NM_RUNC_STAT_CACHE_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The timeout value in seconds for the values in the stat cache.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RUNC_STAT_CACHE_TIMEOUT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default timeout value in seconds for the values in the stat cache.]]>
- </doc>
- </field>
- <field name="NM_RUNC_STAT_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The size of the stat cache which stores stats of the layers and config.]]>
- </doc>
- </field>
- <field name="DEFAULT_RUNC_STAT_CACHE_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default size of the stat cache which stores stats of the
- layers and config.]]>
- </doc>
- </field>
- <field name="DOCKER_CONTAINER_RUNTIME_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_DOCKER_IMAGE_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default docker image to be used.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_IMAGE_UPDATE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default option to decide whether to pull the latest image or not.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Capabilities allowed (and added by default) for docker containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_CONTAINER_CAPABILITIES" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[These are the default capabilities added by docker. We'll use the same
- set here. While these may not be case-sensitive from a docker
- perspective, it is best to keep these uppercase.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Allow privileged containers. Use with extreme care.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_ALLOW_PRIVILEGED_CONTAINERS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Privileged containers are disabled by default.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_ENABLE_USER_REMAPPING" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[enable user remapping.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_ENABLE_USER_REMAPPING" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set enable user remapping as false by default.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_USER_REMAPPING_UID_THRESHOLD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[lower limit for acceptable uids of user remapped user.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_USER_REMAPPING_UID_THRESHOLD" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set user remapping lower uid limit to 1 by default.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_USER_REMAPPING_GID_THRESHOLD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[lower limit for acceptable gids of user remapped user.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_USER_REMAPPING_GID_THRESHOLD" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Set user remapping lower gid limit to 1 by default.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[ACL list for users allowed to run privileged containers.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_PRIVILEGED_CONTAINERS_ACL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default list for users allowed to run privileged containers is empty.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The set of networks allowed when launching containers using the
- DockerContainerRuntime.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_ALLOWED_CONTAINER_NETWORKS" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The set of networks allowed when launching containers using the
- DockerContainerRuntime.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_DEFAULT_CONTAINER_NETWORK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The network used when launching containers using the
- DockerContainerRuntime when no network is specified in the request. This
- network must be one of the (configurable) set of allowed container
- networks.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_DEFAULT_CONTAINER_NETWORK" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The network used when launching containers using the
- DockerContainerRuntime when no network is specified in the request and
- no default network is configured.
- .]]>
- </doc>
- </field>
- <field name="NM_DOCKER_ALLOWED_CONTAINER_RUNTIMES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The set of runtimes allowed when launching containers using the
- DockerContainerRuntime.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_ALLOWED_CONTAINER_RUNTIMES" type="java.lang.String[]"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The set of runtimes allowed when launching containers using the
- DockerContainerRuntime.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_ALLOW_HOST_PID_NAMESPACE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Allow host pid namespace for containers. Use with care.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_ALLOW_HOST_PID_NAMESPACE" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Host pid namespace for containers is disabled by default.]]>
- </doc>
- </field>
- <field name="YARN_HTTP_WEBAPP_EXTERNAL_CLASSES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="HADOOP_HTTP_WEBAPP_SCHEDULER_PAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="This field is deprecated for
- {@link #YARN_HTTP_WEBAPP_SCHEDULER_PAGE}">
- <doc>
- <![CDATA[@deprecated This field is deprecated for
- {@link #YARN_HTTP_WEBAPP_SCHEDULER_PAGE}]]>
- </doc>
- </field>
- <field name="YARN_HTTP_WEBAPP_SCHEDULER_PAGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_HTTP_WEBAPP_CUSTOM_DAO_CLASSES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_HTTP_WEBAPP_CUSTOM_UNWRAPPED_DAO_CLASSES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_DOCKER_ALLOW_DELAYED_REMOVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Whether or not users are allowed to request that Docker containers honor
- the debug deletion delay. This is useful for troubleshooting Docker
- container related launch failures.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_ALLOW_DELAYED_REMOVAL" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default value on whether or not a user can request that Docker
- containers honor the debug deletion delay.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_STOP_GRACE_PERIOD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="use {@link YarnConfiguration#NM_SLEEP_DELAY_BEFORE_SIGKILL_MS}">
- <doc>
- <![CDATA[A configurable value to pass to the Docker Stop command. This value
- defines the number of seconds between the docker stop command sending
- a SIGTERM and a SIGKILL.
- @deprecated use {@link YarnConfiguration#NM_SLEEP_DELAY_BEFORE_SIGKILL_MS}]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_DOCKER_STOP_GRACE_PERIOD" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default value for the grace period between the SIGTERM and the
- SIGKILL in the Docker Stop command.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_DEFAULT_RO_MOUNTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default list of read-only mounts to be bind-mounted into all
- Docker containers that use DockerContainerRuntime.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_DEFAULT_RW_MOUNTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default list of read-write mounts to be bind-mounted into all
- Docker containers that use DockerContainerRuntime.]]>
- </doc>
- </field>
- <field name="NM_DOCKER_DEFAULT_TMPFS_MOUNTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default list of tmpfs mounts to be mounted into all
- Docker containers that use DockerContainerRuntime.]]>
- </doc>
- </field>
- <field name="YARN_CONTAINER_SANDBOX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The mode in which the Java Container Sandbox should run detailed by
- the JavaSandboxLinuxContainerRuntime.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_CONTAINER_SANDBOX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Permissions for application local directories.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_CONTAINER_SANDBOX_FILE_PERMISSIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_CONTAINER_SANDBOX_POLICY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Location for non-default java policy file.]]>
- </doc>
- </field>
- <field name="YARN_CONTAINER_SANDBOX_POLICY_GROUP_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Prefix for group to policy file mapping.]]>
- </doc>
- </field>
- <field name="YARN_CONTAINER_SANDBOX_WHITELIST_GROUP" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The group which will run by default without the java security manager.]]>
- </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_NONSECURE_MODE_LIMIT_USERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[True 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="RM_APPLICATION_MONITOR_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_APPLICATION_MONITOR_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_APPLICATION_HTTPS_POLICY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Specifies what the RM does regarding HTTPS enforcement for communication
- with AM Web Servers, as well as generating and providing certificates.
- Possible values are:
- <ul>
- <li>NONE - the RM will do nothing special.</li>
- <li>LENIENT - the RM will generate and provide a keystore and truststore
- to the AM, which it is free to use for HTTPS in its tracking URL web
- server. The RM proxy will still allow HTTP connections to AMs that opt
- not to use HTTPS.</li>
- <li>STRICT - this is the same as LENIENT, except that the RM proxy will
- only allow HTTPS connections to AMs; HTTP connections will be blocked
- and result in a warning page to the user.</li>
- </ul>]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_APPLICATION_HTTPS_POLICY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PROXY_TIMEOUT_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFALUT_RM_PROXY_TIMEOUT_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_PROXY_CONNECTION_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_PROXY_CONNECTION_TIMEOUT" type="int"
- 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_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Delay between attempts to remove linux cgroup.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_LINUX_CONTAINER_CGROUPS_DELETE_DELAY" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Indicates if memory and CPU limits will be set for the Windows Job
- Object for the containers launched by the default container executor.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_WINDOWS_CONTAINER_MEMORY_LIMIT_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_WINDOWS_CONTAINER_CPU_LIMIT_ENABLED" type="boolean"
- 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_SERVICES_MANIFEST_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Boolean indicating whether loading aux services from a manifest is
- enabled. If enabled, aux services may be dynamically modified through
- reloading the manifest via filesystem changes or a REST API. When
- enabled, aux services configuration properties unrelated to the manifest
- will be ignored.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_AUX_SERVICES_MANIFEST_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_AUX_SERVICES_MANIFEST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[File containing auxiliary service specifications.]]>
- </doc>
- </field>
- <field name="NM_AUX_SERVICES_MANIFEST_RELOAD_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Interval at which manifest file will be reloaded when modifications are
- found (0 or less means that the file will not be checked for modifications
- and reloaded).]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_AUX_SERVICES_MANIFEST_RELOAD_MS" type="long"
- 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_AUX_SERVICES_CLASSPATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_AUX_SERVICE_REMOTE_CLASSPATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_AUX_SERVICES_SYSTEM_CLASSES" 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_CONTAINER_STDERR_PATTERN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_CONTAINER_STDERR_PATTERN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINER_STDERR_BYTES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_CONTAINER_STDERR_BYTES" type="long"
- 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="NM_RECOVERY_COMPACTION_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The time in seconds between full compactions of the NM state database.
- Setting the interval to zero disables the full compaction cycles.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_RECOVERY_COMPACTION_INTERVAL_SECS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_RECOVERY_SUPERVISED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_RECOVERY_SUPERVISED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_AGG_POLICY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_LOG_AGG_POLICY_CLASS_PARAMETERS" 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="PROXY_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Binding address for the web proxy.]]>
- </doc>
- </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_DISTRIBUTEDSCHEDULING_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="YARN_SECURITY_SERVICE_AUTHORIZATION_COLLECTOR_NODEMANAGER_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_NODEMANAGER_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="DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_DISPATCHER_DRAIN_EVENTS_TIMEOUT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_DISPATCHER_PRINT_EVENTS_INFO_THRESHOLD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The threshold used to trigger the logging of event types and counts
- in RM's main event dispatcher. Default value is 5000,
- which means RM will print events info when the queue size cumulatively
- reaches 5000 every time. Such info can be used to reveal what
- kind of events that RM is stuck at processing mostly,
- it can help to narrow down certain performance issues.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_DISPATCHER_PRINT_EVENTS_INFO_THRESHOLD" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_DISPATCHER_CPU_MONITOR_SAMPLES_PER_MIN" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Resource manager dispatcher thread monitor sampling rate.
- Units are samples per minute. This controls how often to sample
- the cpu utilization of the resource manager dispatcher thread.
- The cpu utilization is displayed on the RM UI as scheduler busy %.
- Set to zero to disable the dispatcher thread monitor.]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_DISPATCHER_CPU_MONITOR_SAMPLES_PER_MIN" type="int"
- 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="AMRM_PROXY_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 AMRMProxy is enabled or not.]]>
- </doc>
- </field>
- <field name="DEFAULT_AMRM_PROXY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AMRM_PROXY_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AMRM_PROXY_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AMRM_PROXY_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AMRM_PROXY_CLIENT_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AMRM_PROXY_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AMRM_PROXY_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AMRM_PROXY_HA_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AMRM_PROXY_HA_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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_MINICLUSTER_NM_PMEM_MB" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Allow changing the memory for the NodeManager in the MiniYARNCluster]]>
- </doc>
- </field>
- <field name="DEFAULT_YARN_MINICLUSTER_NM_PMEM_MB" type="int"
- 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="TIMELINE_SERVICE_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_VERSION" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_VERSIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_UI_NAMES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Comma separated list of names for UIs hosted in the timeline server
- (For pluggable UIs).]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_UI_WEB_PATH_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Relative web path that will serve up this UI (For pluggable UIs).]]>
- </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_UI_ON_DISK_PATH_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Path to war file or static content directory for this UI
- (For pluggable UIs).]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting for timeline service v1.5]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CACHE_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_ACTIVE_DIR_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_DONE_DIR_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_CLASSPATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITY_GROUP_PLUGIN_SYSTEM_CLASSES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_STORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SUMMARY_ENTITY_TYPES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_SCAN_INTERVAL_SECONDS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_THREADS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_APP_CACHE_SIZE_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_CLEANER_INTERVAL_SECONDS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_RETAIN_SECONDS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_UNKNOWN_ACTIVE_SECONDS_DEFAULT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_CACHE_READ_CACHE_SIZE" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_FD_FLUSH_INTERVAL_SECS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_FD_CLEAN_INTERVAL_SECS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_FD_RETAIN_SECS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_TIMERS_TTL_SECS_DEFAULT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_INTERNAL_ATTEMPT_DIR_CACHE_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYFILE_FS_SUPPORT_APPEND" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_ENTITYGROUP_FS_STORE_WITH_USER_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_READER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Settings for timeline service v2.0.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_WRITER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WRITER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_READER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_READER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_SCHEMA_CREATOR_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_SCHEMA_CREATOR_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_HBASE_SCHEMA_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default schema prefix for hbase tables.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_HBASE_SCHEMA_PREFIX_NAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[config param name to override schema prefix.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_WRITER_FLUSH_INTERVAL_SECONDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting that controls how often the timeline collector flushes the
- timeline writer.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WRITER_FLUSH_INTERVAL_SECONDS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_WRITER_ASYNC_QUEUE_CAPACITY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting that controls the capacity of the queue for async writes
- to timeline collector.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_WRITER_ASYNC_QUEUE_CAPACITY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APP_FINAL_VALUE_RETENTION_THRESHOLD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name for setting that controls how long the final value of
- a metric of a completed app is retained before merging
- into the flow sum.]]>
- </doc>
- </field>
- <field name="FLOW_RUN_COPROCESSOR_JAR_HDFS_LOCATION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name of the setting for the location of the coprocessor
- jar on hdfs.]]>
- </doc>
- </field>
- <field name="DEFAULT_HDFS_LOCATION_FLOW_RUN_COPROCESSOR_JAR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default hdfs location for flowrun coprocessor jar.]]>
- </doc>
- </field>
- <field name="FLOW_NAME_MAX_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[This setting controls the max size of the flow name getting generated
- in ATSv2 after removing UUID if present.]]>
- </doc>
- </field>
- <field name="FLOW_NAME_DEFAULT_MAX_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default setting for flow name size has no size restriction
- after removing UUID if present.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_HBASE_CONFIGURATION_FILE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name for setting that points to an optional HBase configuration
- (hbase-site.xml file) with settings that will override the ones found on
- the classpath.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_READ_AUTH_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name for setting that enables or disables authentication checks
- for reading timeline service v2 data.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_AGGREGATION_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name for setting that controls how often in-memory app level
- aggregation is kicked off in timeline collector.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_AGGREGATION_INTERVAL_SECS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_READ_AUTH_ENABLED" type="java.lang.Boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default setting for authentication checks for reading timeline
- service v2 data.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_READ_ALLOWED_USERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The name for setting that lists the users and groups who are allowed
- to read timeline service v2 data. It is a comma separated list of
- user, followed by space, then comma separated list of groups.
- It will allow this list of users and groups to read the data
- and reject everyone else.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_READ_ALLOWED_USERS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The default value for list of the users who are allowed to read
- timeline service v2 data.]]>
- </doc>
- </field>
- <field name="DEFAULT_APP_FINAL_VALUE_RETENTION_THRESHOLD" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The setting that controls how long the final value of a metric of a
- completed app is retained before merging into the flow sum. Up to this time
- after an application is completed out-of-order values that arrive can be
- recognized and discarded at the cost of increased storage.]]>
- </doc>
- </field>
- <field name="ATS_APP_COLLECTOR_LINGER_PERIOD_IN_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ATS_APP_COLLECTOR_LINGER_PERIOD_IN_MS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NUMBER_OF_ASYNC_ENTITIES_TO_MERGE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NUMBER_OF_ASYNC_ENTITIES_TO_MERGE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FLOW_VERSION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[default version for any flow.]]>
- </doc>
- </field>
- <field name="TIMELINE_V2_CLIENT_DRAIN_TIME_MILLIS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The time period for which timeline v2 client will wait for draining
- leftover entities after stop.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_V2_CLIENT_DRAIN_TIME_MILLIS" type="long"
- 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="APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Save container meta-info in the application history store.]]>
- </doc>
- </field>
- <field name="DEFAULT_APPLICATION_HISTORY_SAVE_NON_AM_CONTAINER_META_INFO" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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="DEFAULT_TIMELINE_SERVICE_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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="APPLICATION_HISTORY_MAX_APPS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Defines the max number of applications could be fetched using
- REST API or application history protocol and shown in timeline
- server web ui.]]>
- </doc>
- </field>
- <field name="DEFAULT_APPLICATION_HISTORY_MAX_APPS" type="long"
- 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_ROLLING_PERIOD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service rolling period. Valid values are daily, half_daily,
- quarter_daily, and hourly.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_ROLLING_PERIOD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Roll a new database each hour.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Implementation specific configuration prefix for Timeline Service
- leveldb.]]>
- </doc>
- </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). This is
- per rolling instance so should be tuned if using rolling leveldb
- timeline store]]>
- </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">
- <doc>
- <![CDATA[Default leveldb read cache size if no configuration is specified.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb write buffer size.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BUFFER_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default leveldb write buffer size if no configuration is specified. This
- is per rolling instance so should be tuned if using rolling leveldb
- timeline store.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb write batch size. This value can be tuned down
- to reduce lock time for ttl eviction.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_WRITE_BATCH_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default leveldb write batch size is no configuration is specified]]>
- </doc>
- </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_LEVELDB_MAX_OPEN_FILES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service leveldb number of concurrent open files. Tuned this
- configuration to stay within system limits. This is per rolling instance
- so should be tuned if using rolling leveldb timeline store.]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_LEVELDB_MAX_OPEN_FILES" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Default leveldb max open files if no configuration is specified.]]>
- </doc>
- </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_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="TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline client policy for whether connections are fatal]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_CLIENT_BEST_EFFORT" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_RECOVERY_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flag to enable recovery of timeline service]]>
- </doc>
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_RECOVERY_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_STATE_STORE_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service state store class]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_LEVELDB_STATE_STORE_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Timeline service state store leveldb path]]>
- </doc>
- </field>
- <field name="TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_DELEGATION_KEY_UPDATE_INTERVAL" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_RENEW_INTERVAL" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_DELEGATION_TOKEN_MAX_LIFETIME" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_OFFLINE_AGGREGATION_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PHOENIX_OFFLINE_STORAGE_CONN_STR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="PHOENIX_OFFLINE_STORAGE_CONN_STR_DEFAULT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[whether the shared cache is enabled/disabled]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_ROOT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The config key for the shared cache root directory.]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_ROOT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_NESTED_LEVEL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The config key for the level of nested directories before getting to the
- checksum directory.]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_NESTED_LEVEL" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_STORE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_STORE_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_STORE_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_APP_CHECKER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_APP_CHECKER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_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 SCM admin interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_ADMIN_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_ADMIN_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_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 SCM admin interface.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_ADMIN_CLIENT_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_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 SCM web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_WEBAPP_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_MEMORY_STORE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_MEMORY_STALENESS_PERIOD_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[A resource in the InMemorySCMStore is considered stale if the time since
- the last reference exceeds the staleness period. This value is specified in
- minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IN_MEMORY_STALENESS_PERIOD_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_MEMORY_INITIAL_DELAY_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Initial delay before the in-memory store runs its first check to remove
- dead initial applications. Specified in minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IN_MEMORY_INITIAL_DELAY_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="IN_MEMORY_CHECK_PERIOD_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The frequency at which the in-memory store checks to remove dead initial
- applications. Specified in minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_IN_MEMORY_CHECK_PERIOD_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLEANER_PERIOD_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The frequency at which a cleaner task runs. Specified in minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLEANER_PERIOD_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLEANER_INITIAL_DELAY_MINS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Initial delay before the first cleaner task is scheduled. Specified in
- minutes.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLEANER_INITIAL_DELAY_MINS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLEANER_RESOURCE_SLEEP_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The time to sleep between processing each shared cache resource. Specified
- in milliseconds.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLEANER_RESOURCE_SLEEP_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the node manager interface in the SCM.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_UPLOADER_SERVER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_UPLOADER_SERVER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_UPLOADER_SERVER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of SCM threads used to handle notify requests from the node
- manager.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_UPLOADER_SERVER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The address of the client interface in the SCM.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLIENT_SERVER_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SCM_CLIENT_SERVER_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCM_CLIENT_SERVER_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 shared cache manager requests.]]>
- </doc>
- </field>
- <field name="DEFAULT_SCM_CLIENT_SERVER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[the checksum algorithm implementation]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_CHECKSUM_ALGO_IMPL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The replication factor for the node manager uploader for the shared cache.]]>
- </doc>
- </field>
- <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_REPLICATION_FACTOR" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_SHARED_CACHE_NM_UPLOADER_THREAD_COUNT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_FAILOVER_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_FAILOVER_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_STATESTORE_CLIENT_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_STATESTORE_CLIENT_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_CACHE_TIME_TO_LIVE_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_CACHE_TIME_TO_LIVE_SECS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_FLUSH_CACHE_FOR_RM_ADDR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_FLUSH_CACHE_FOR_RM_ADDR" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_REGISTRY_BASE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_REGISTRY_BASE_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_STATESTORE_HEARTBEAT_INTERVAL_SECS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_STATESTORE_HEARTBEAT_INTERVAL_SECS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_MACHINE_LIST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_CLUSTER_RESOLVER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_CLUSTER_RESOLVER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_AMRMPROXY_HB_MAX_WAIT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_AMRMPROXY_HB_MAX_WAIT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_AMRMPROXY_SUBCLUSTER_TIMEOUT" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_AMRMPROXY_SUBCLUSTER_TIMEOUT" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_POLICY_KEY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_POLICY_MANAGER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_POLICY_MANAGER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_POLICY_MANAGER_PARAMS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_POLICY_MANAGER_PARAMS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_STATESTORE_ZK_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_STATESTORE_ZK_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_FEDERATION_STATESTORE_ZK_PARENT_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_STATESTORE_SQL_USERNAME" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_STATESTORE_SQL_PASSWORD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_STATESTORE_SQL_URL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_STATESTORE_SQL_JDBC_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_STATESTORE_SQL_JDBC_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FEDERATION_STATESTORE_SQL_MAXCONNECTIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FEDERATION_STATESTORE_SQL_MAXCONNECTIONS" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_CLIENTRM_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_CLIENTRM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_CLIENTRM_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_CLIENTRM_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_CLIENTRM_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_CLIENTRM_INTERCEPTOR_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_PIPELINE_CACHE_MAX_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_PIPELINE_CACHE_MAX_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_RMADMIN_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_RMADMIN_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_RMADMIN_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_RMADMIN_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_RMADMIN_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_RMADMIN_INTERCEPTOR_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_CLIENTRM_SUBMIT_RETRY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The number of retries for GetNewApplication and SubmitApplication in
- {@code FederationClientInterceptor}.]]>
- </doc>
- </field>
- <field name="DEFAULT_ROUTER_CLIENTRM_SUBMIT_RETRY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_WEBAPP_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_USER_CLIENT_THREADS_SIZE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_USER_CLIENT_THREADS_SIZE" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_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 Router web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_ROUTER_WEBAPP_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_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 Router web application.]]>
- </doc>
- </field>
- <field name="DEFAULT_ROUTER_WEBAPP_HTTPS_PORT" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_WEBAPP_INTERCEPTOR_CLASS_PIPELINE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ROUTER_WEBAPP_INTERCEPTOR_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_WEBAPP_DEFAULT_INTERCEPTOR_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The interceptor class used in FederationInterceptorREST to communicate with
- each SubCluster.]]>
- </doc>
- </field>
- <field name="DEFAULT_ROUTER_WEBAPP_DEFAULT_INTERCEPTOR_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ROUTER_WEBAPP_PARTIAL_RESULTS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The interceptor class used in FederationInterceptorREST should return
- partial AppReports.]]>
- </doc>
- </field>
- <field name="DEFAULT_ROUTER_WEBAPP_PARTIAL_RESULTS_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CSI_ADAPTOR_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[TERMS:
- csi-driver: a 3rd party CSI driver which implements the CSI protocol.
- It is provided by the storage system.
- csi-driver-adaptor: this is an internal RPC service working
- as a bridge between YARN and a csi-driver.]]>
- </doc>
- </field>
- <field name="NM_CSI_DRIVER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CSI_DRIVER_ENDPOINT_SUFFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CSI_ADAPTOR_ADDRESS_SUFFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CSI_ADAPTOR_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CSI_ADAPTOR_ADDRESSES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[One or more socket addresses for csi-adaptor.
- Multiple addresses are delimited by ",".]]>
- </doc>
- </field>
- <field name="NM_CSI_DRIVER_NAMES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_REGISTRY_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_YARN_REGISTRY_CLASS" type="java.lang.String"
- 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="NM_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 for NM to connection to RM.
- When not set, proxy will fall back to use value of
- RESOURCEMANAGER_CONNECT_MAX_WAIT_MS.]]>
- </doc>
- </field>
- <field name="NM_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 NM attempt to connection to RM.
- When not set, proxy will fall back to use value of
- RESOURCEMANAGER_CONNECT_RETRY_INTERVAL_MS.]]>
- </doc>
- </field>
- <field name="NODE_LABELS_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Node-labels configurations]]>
- </doc>
- </field>
- <field name="FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Node label store implementation class]]>
- </doc>
- </field>
- <field name="DEFAULT_FS_NODE_LABELS_STORE_IMPL_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </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="NODE_ATTRIBUTE_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Node-attribute configurations.]]>
- </doc>
- </field>
- <field name="FS_NODE_ATTRIBUTE_STORE_IMPL_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Node attribute store implementation class.]]>
- </doc>
- </field>
- <field name="FS_NODE_ATTRIBUTE_STORE_ROOT_DIR" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[File system node attribute store directory.]]>
- </doc>
- </field>
- <field name="NODE_LABELS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Flag to indicate if the node labels feature enabled, by default it's
- disabled]]>
- </doc>
- </field>
- <field name="DEFAULT_NODE_LABELS_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CENTRALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DELEGATED_CENTALIZED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DISTRIBUTED_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NODELABEL_CONFIGURATION_TYPE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EXCLUSIVE_ENFORCED_PARTITIONS_SUFFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="EXCLUSIVE_ENFORCED_PARTITIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="MAX_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_CLUSTER_LEVEL_APPLICATION_PRIORITY" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="APP_ATTEMPT_DIAGNOSTICS_LIMIT_KC" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_APP_ATTEMPT_DIAGNOSTICS_LIMIT_KC" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NODE_ATTRIBUTES_PROVIDER_CONFIG" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="CONFIG_NODE_DESCRIPTOR_PROVIDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="SCRIPT_NODE_DESCRIPTOR_PROVIDER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NODE_LABELS_RESYNC_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_NODE_LABELS_RESYNC_INTERVAL" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NODE_ATTRIBUTES_RESYNC_INTERVAL" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_NODE_ATTRIBUTES_RESYNC_INTERVAL" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_NODE_LABELS_PROVIDER_FETCH_TIMEOUT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PROVIDER_CONFIGURED_NODE_PARTITION" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_PROVIDER_CONFIGURED_NODE_ATTRIBUTES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODE_LABELS_PROVIDER_CONFIG" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_RM_NODE_LABELS_PROVIDER_FETCH_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_AM_SCHEDULING_NODE_BLACKLISTING_DISABLE_THRESHOLD" type="float"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_SCRIPT_BASED_NODE_LABELS_PROVIDER_SCRIPT_OPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NODE_ATTRIBUTES_PROVIDER_FETCH_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Node attribute provider fetch attributes interval and timeout.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NODE_ATTRIBUTES_PROVIDER_FETCH_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NODE_ATTRIBUTES_PROVIDER_FETCH_TIMEOUT_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_NODE_ATTRIBUTES_PROVIDER_FETCH_TIMEOUT_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_SCRIPT_BASED_NODE_ATTRIBUTES_PROVIDER_PATH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_SCRIPT_BASED_NODE_ATTRIBUTES_PROVIDER_OPTS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DISPLAY_APPS_FOR_LOGGED_IN_USER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FILTER_ENTITY_LIST_BY_USER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_DISPLAY_APPS_FOR_LOGGED_IN_USER" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="FILTER_INVALID_XML_CHARS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_FILTER_INVALID_XML_CHARS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="ENABLE_REST_APP_SUBMISSIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_ENABLE_REST_APP_SUBMISSIONS" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="REST_CSRF" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CSRF_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CSRF_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_CSRF_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CSRF_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CSRF_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_CSRF_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CSRF_CUSTOM_HEADER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CSRF_CUSTOM_HEADER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_CSRF_CUSTOM_HEADER" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_CSRF_METHODS_TO_IGNORE" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="XFS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="YARN_XFS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_XFS_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_XFS_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_XFS_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_XFS_OPTIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_XFS_OPTIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_XFS_OPTIONS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_READER_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Settings for timeline reader.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_READER_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_READER_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_READER_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_READER_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_READER_STORAGE_MONITOR_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_STORAGE_MONITOR_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_COLLECTOR_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Marked collector properties as Private since it run as auxillary service.]]>
- </doc>
- </field>
- <field name="TIMELINE_SERVICE_COLLECTOR_BIND_HOST" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_COLLECTOR_BIND_PORT_RANGES" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_COLLECTOR_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_COLLECTOR_WEBAPP_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="TIMELINE_SERVICE_COLLECTOR_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_TIMELINE_SERVICE_COLLECTOR_WEBAPP_HTTPS_ADDRESS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NUMA_AWARENESS_ENABLED" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Settings for NUMA awareness.]]>
- </doc>
- </field>
- <field name="DEFAULT_NM_NUMA_AWARENESS_ENABLED" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NUMA_AWARENESS_READ_TOPOLOGY" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_NUMA_AWARENESS_READ_TOPOLOGY" type="boolean"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NUMA_AWARENESS_NODE_IDS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_NUMA_AWARENESS_NUMACTL_CMD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_NM_NUMA_AWARENESS_NUMACTL_CMD" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ACTIVITIES_MANAGER_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Settings for activities manager.]]>
- </doc>
- </field>
- <field name="RM_ACTIVITIES_MANAGER_SCHEDULER_ACTIVITIES_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ACTIVITIES_MANAGER_CLEANUP_INTERVAL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[The cleanup interval for activities in milliseconds.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_ACTIVITIES_MANAGER_CLEANUP_INTERVAL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ACTIVITIES_MANAGER_SCHEDULER_ACTIVITIES_TTL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Time to live for scheduler activities in milliseconds.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_ACTIVITIES_MANAGER_SCHEDULER_ACTIVITIES_TTL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_TTL_MS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Time to live for app activities in milliseconds.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_TTL_MS" type="long"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_MAX_QUEUE_LENGTH" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Max queue length for app activities.]]>
- </doc>
- </field>
- <field name="DEFAULT_RM_ACTIVITIES_MANAGER_APP_ACTIVITIES_MAX_QUEUE_LENGTH" type="int"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="NM_CONTAINERS_LAUNCHER_CLASS" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Containers launcher implementation to use.]]>
- </doc>
- </field>
- <field name="YARN_WORKFLOW_ID_TAG_PREFIX" type="java.lang.String"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <field name="DEFAULT_YARN_WORKFLOW_ID_TAG_PREFIX" 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.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.ConfigurationException -->
- <class name="ConfigurationException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ConfigurationException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ConfigurationException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ConfigurationException" type="java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown on unrecoverable configuration errors.
- An example is container launch error due to configuration.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ConfigurationException -->
- <!-- 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.ResourceNotFoundException -->
- <class name="ResourceNotFoundException" extends="org.apache.hadoop.yarn.exceptions.YarnRuntimeException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ResourceNotFoundException" type="org.apache.hadoop.yarn.api.records.Resource, java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ResourceNotFoundException" type="org.apache.hadoop.yarn.api.records.Resource, java.lang.String, java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ResourceNotFoundException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <doc>
- <![CDATA[This exception is thrown when details of an unknown resource type
- are requested.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.ResourceNotFoundException -->
- <!-- 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 -->
- <!-- start class org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException -->
- <class name="YARNFeatureNotEnabledException" extends="org.apache.hadoop.yarn.exceptions.YarnException"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="YARNFeatureNotEnabledException" type="java.lang.Throwable"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YARNFeatureNotEnabledException" type="java.lang.String"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="YARNFeatureNotEnabledException" 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 feature is being used which is not enabled
- yet.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.exceptions.YARNFeatureNotEnabledException -->
- </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 interface org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler -->
- <interface name="AuxiliaryLocalPathHandler" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="getLocalPathForRead" return="org.apache.hadoop.fs.Path"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a path from the local FS for reading for a given Auxiliary Service.
- @param path the requested path
- @return the complete path to the file on a local disk
- @throws IOException if the file read encounters a problem]]>
- </doc>
- </method>
- <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a path from the local FS for writing for a given Auxiliary Service.
- @param path the requested path
- @return the complete path to the file on a local disk
- @throws IOException if the path creations fails]]>
- </doc>
- </method>
- <method name="getLocalPathForWrite" return="org.apache.hadoop.fs.Path"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <param name="size" type="long"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get a path from the local FS for writing a file of an estimated size
- for a given Auxiliary Service.
- @param path the requested path
- @param size the size of the file that is going to be written
- @return the complete path to the file on a local disk
- @throws IOException if the path creations fails]]>
- </doc>
- </method>
- <method name="getAllLocalPathsForRead" return="java.lang.Iterable"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="path" type="java.lang.String"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[Get all paths from the local FS for reading for a given Auxiliary Service.
- @param path the requested path
- @return the complete path list to the file on a local disk as an Iterable
- @throws IOException if the file read encounters a problem]]>
- </doc>
- </method>
- <doc>
- <![CDATA[An Interface that can retrieve local directories to read from or write to.
- Components can implement this interface to link it to
- their own Directory Handler Service]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler -->
- <!-- 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>
- <method name="getAuxiliaryLocalPathHandler" return="org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Method that gets the local dirs path handler for this Auxiliary Service.
- @return auxiliaryPathHandler object that is used to read from and write to
- valid local Dirs.]]>
- </doc>
- </method>
- <method name="setAuxiliaryLocalPathHandler"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="auxiliaryLocalPathHandler" type="org.apache.hadoop.yarn.server.api.AuxiliaryLocalPathHandler"/>
- <doc>
- <![CDATA[Method that sets the local dirs path handler for this Auxiliary Service.
- @param auxiliaryLocalPathHandler the pathHandler for this auxiliary service]]>
- </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>
- <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <constructor name="ContainerContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType, org.apache.hadoop.yarn.api.records.ExecutionType"
- 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>
- <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link ContainerType} the type of the container
- being initialized or stopped.
- @return the type of the container]]>
- </doc>
- </method>
- <method name="getExecutionType" return="org.apache.hadoop.yarn.api.records.ExecutionType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link ExecutionType} the execution type of the container
- being initialized or stopped.
- @return the execution type of the container]]>
- </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>
- <constructor name="ContainerInitializationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType"
- 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 interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
- <interface name="ContainerLogAggregationPolicy" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="parseParameters"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="parameters" type="java.lang.String"/>
- <doc>
- <![CDATA[<p>
- The method used by the NodeManager log aggregation service
- to initial the policy object with parameters specified by the application
- or the cluster-wide setting.
- </p>
- @param parameters parameters with scheme defined by the policy class.]]>
- </doc>
- </method>
- <method name="shouldDoLogAggregation" return="boolean"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="logContext" type="org.apache.hadoop.yarn.server.api.ContainerLogContext"/>
- <doc>
- <![CDATA[<p>
- The method used by the NodeManager log aggregation service
- to ask the policy object if a given container's logs should be aggregated.
- </p>
- @param logContext ContainerLogContext
- @return Whether or not the container's logs should be aggregated.]]>
- </doc>
- </method>
- <doc>
- <![CDATA[This API is used by NodeManager to decide if a given container's logs
- should be aggregated at run time.]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.server.api.ContainerLogAggregationPolicy -->
- <!-- start class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
- <class name="ContainerLogContext" extends="java.lang.Object"
- abstract="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <constructor name="ContainerLogContext" type="org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.server.api.ContainerType, int"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- </constructor>
- <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.
- @return the container ID]]>
- </doc>
- </method>
- <method name="getContainerType" return="org.apache.hadoop.yarn.server.api.ContainerType"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get {@link ContainerType} the type of the container.
- @return the type of the container]]>
- </doc>
- </method>
- <method name="getExitCode" return="int"
- abstract="false" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <doc>
- <![CDATA[Get the exit code of the container.
- @return the exit code]]>
- </doc>
- </method>
- <doc>
- <![CDATA[Context class for {@link ContainerLogAggregationPolicy}.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.server.api.ContainerLogContext -->
- <!-- 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>
- <constructor name="ContainerTerminationContext" type="java.lang.String, org.apache.hadoop.yarn.api.records.ContainerId, org.apache.hadoop.yarn.api.records.Resource, org.apache.hadoop.yarn.server.api.ContainerType"
- 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 -->
- <!-- start interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
- <interface name="SCMAdminProtocol" abstract="true"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <method name="runCleanerTask" return="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskResponse"
- abstract="true" native="false" synchronized="false"
- static="false" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="request" type="org.apache.hadoop.yarn.server.api.protocolrecords.RunSharedCacheCleanerTaskRequest"/>
- <exception name="YarnException" type="org.apache.hadoop.yarn.exceptions.YarnException"/>
- <exception name="IOException" type="java.io.IOException"/>
- <doc>
- <![CDATA[<p>
- The method used by administrators to ask SCM to run cleaner task right away
- </p>
- @param request request <code>SharedCacheManager</code> to run a cleaner task
- @return <code>SharedCacheManager</code> returns an empty response
- on success and throws an exception on rejecting the request
- @throws YarnException
- @throws IOException]]>
- </doc>
- </method>
- <doc>
- <![CDATA[<p>
- The protocol between administrators and the <code>SharedCacheManager</code>
- </p>]]>
- </doc>
- </interface>
- <!-- end interface org.apache.hadoop.yarn.server.api.SCMAdminProtocol -->
- </package>
- <package name="org.apache.hadoop.yarn.util">
- </package>
- <package name="org.apache.hadoop.yarn.util.constraint">
- <!-- start class org.apache.hadoop.yarn.util.constraint.PlacementConstraintParser -->
- <class name="PlacementConstraintParser" extends="java.lang.Object"
- abstract="false"
- static="false" final="true" visibility="public"
- deprecated="not deprecated">
- <method name="parseExpression" return="org.apache.hadoop.yarn.api.resource.PlacementConstraint.AbstractConstraint"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="constraintStr" type="java.lang.String"/>
- <exception name="PlacementConstraintParseException" type="org.apache.hadoop.yarn.util.constraint.PlacementConstraintParseException"/>
- <doc>
- <![CDATA[Parses a given constraint expression to a {@link AbstractConstraint},
- this expression can be any valid form of constraint expressions.
- @param constraintStr expression string
- @return a parsed {@link AbstractConstraint}
- @throws PlacementConstraintParseException when given expression
- is malformed]]>
- </doc>
- </method>
- <method name="parsePlacementSpec" return="java.util.Map"
- abstract="false" native="false" synchronized="false"
- static="true" final="false" visibility="public"
- deprecated="not deprecated">
- <param name="expression" type="java.lang.String"/>
- <exception name="PlacementConstraintParseException" type="org.apache.hadoop.yarn.util.constraint.PlacementConstraintParseException"/>
- <doc>
- <![CDATA[Parses a placement constraint specification. A placement constraint spec
- is a composite expression which is composed by multiple sub constraint
- expressions delimited by ":". With following syntax:
- <p>Tag1(N1),P1:Tag2(N2),P2:...:TagN(Nn),Pn</p>
- where <b>TagN(Nn)</b> is a key value pair to determine the source
- allocation tag and the number of allocations, such as:
- <p>foo(3)</p>
- Optional when using NodeAttribute Constraint.
- and where <b>Pn</b> can be any form of a valid constraint expression,
- such as:
- <ul>
- <li>in,node,foo,bar</li>
- <li>notin,node,foo,bar,1,2</li>
- <li>and(notin,node,foo:notin,node,bar)</li>
- </ul>
- and NodeAttribute Constraint such as
- <ul>
- <li>yarn.rm.io/foo=true</li>
- <li>java=1.7,1.8</li>
- </ul>
- @param expression expression string.
- @return a map of source tags to placement constraint mapping.
- @throws PlacementConstraintParseException]]>
- </doc>
- </method>
- <field name="EXPRESSION_VAL_DELIM" type="char"
- transient="false" volatile="false"
- static="true" final="true" visibility="public"
- deprecated="not deprecated">
- </field>
- <doc>
- <![CDATA[Placement constraint expression parser.]]>
- </doc>
- </class>
- <!-- end class org.apache.hadoop.yarn.util.constraint.PlacementConstraintParser -->
- </package>
- <package name="org.apache.hadoop.yarn.util.csi">
- </package>
- <package name="org.apache.hadoop.yarn.util.resource">
- </package>
- </api>
|