Minio.xml 269 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Minio</name>
  5. </assembly>
  6. <members>
  7. <member name="M:Minio.MinioClient.ListBucketsAsync(System.Threading.CancellationToken)">
  8. <summary>
  9. List all the buckets for the current Endpoint URL
  10. </summary>
  11. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  12. <returns>Task with an iterator lazily populated with objects</returns>
  13. </member>
  14. <member name="M:Minio.MinioClient.BucketExistsAsync(Minio.DataModel.Args.BucketExistsArgs,System.Threading.CancellationToken)">
  15. <summary>
  16. Check if a private bucket with the given name exists.
  17. </summary>
  18. <param name="args">BucketExistsArgs Arguments Object which has bucket identifier information - bucket name, region</param>
  19. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  20. <returns> Task </returns>
  21. </member>
  22. <member name="M:Minio.MinioClient.RemoveBucketAsync(Minio.DataModel.Args.RemoveBucketArgs,System.Threading.CancellationToken)">
  23. <summary>
  24. Remove the bucket with the given name.
  25. </summary>
  26. <param name="args">RemoveBucketArgs Arguments Object which has bucket identifier information like bucket name .etc.</param>
  27. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  28. <returns> Task </returns>
  29. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucketName is invalid</exception>
  30. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucketName is not found</exception>
  31. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucketName is null</exception>
  32. </member>
  33. <member name="M:Minio.MinioClient.MakeBucketAsync(Minio.DataModel.Args.MakeBucketArgs,System.Threading.CancellationToken)">
  34. <summary>
  35. Create a bucket with the given name.
  36. </summary>
  37. <param name="args">MakeBucketArgs Arguments Object that has bucket info like name, location. etc</param>
  38. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  39. <returns> Task </returns>
  40. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  41. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucketName is invalid</exception>
  42. <exception cref="T:System.NotImplementedException">When object-lock or another extension is not implemented</exception>
  43. </member>
  44. <member name="M:Minio.MinioClient.GetVersioningAsync(Minio.DataModel.Args.GetVersioningArgs,System.Threading.CancellationToken)">
  45. <summary>
  46. Get Versioning information on the bucket with given bucket name
  47. </summary>
  48. <param name="args">GetVersioningArgs takes bucket as argument. </param>
  49. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  50. <returns> GetVersioningResponse with information populated from REST response </returns>
  51. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucketName is invalid</exception>
  52. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  53. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  54. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  55. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  56. </member>
  57. <member name="M:Minio.MinioClient.SetVersioningAsync(Minio.DataModel.Args.SetVersioningArgs,System.Threading.CancellationToken)">
  58. <summary>
  59. Set Versioning as specified on the bucket with given bucket name
  60. </summary>
  61. <param name="args">SetVersioningArgs Arguments Object with information like Bucket name, Versioning configuration</param>
  62. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  63. <returns> Task </returns>
  64. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  65. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  66. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  67. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  68. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  69. </member>
  70. <member name="M:Minio.MinioClient.ListObjectsAsync(Minio.DataModel.Args.ListObjectsArgs,System.Threading.CancellationToken)">
  71. <summary>
  72. List all objects along with versions non-recursively in a bucket with a given prefix, optionally emulating a
  73. directory
  74. </summary>
  75. <param name="args">
  76. ListObjectsArgs Arguments Object with information like Bucket name, prefix, recursive listing,
  77. versioning
  78. </param>
  79. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  80. <returns>An observable of items that client can subscribe to</returns>
  81. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  82. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  83. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  84. <exception cref="T:System.NotImplementedException">If a functionality or extension (like versioning) is not implemented</exception>
  85. <exception cref="T:System.InvalidOperationException">
  86. For example, if you call ListObjectsAsync on a bucket with versioning
  87. enabled or object lock enabled
  88. </exception>
  89. </member>
  90. <member name="M:Minio.MinioClient.GetBucketNotificationsAsync(Minio.DataModel.Args.GetBucketNotificationsArgs,System.Threading.CancellationToken)">
  91. <summary>
  92. Gets notification configuration for this bucket
  93. </summary>
  94. <param name="args">GetBucketNotificationsArgs Arguments Object with information like Bucket name</param>
  95. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  96. <returns></returns>
  97. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  98. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  99. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  100. </member>
  101. <member name="M:Minio.MinioClient.SetBucketNotificationsAsync(Minio.DataModel.Args.SetBucketNotificationsArgs,System.Threading.CancellationToken)">
  102. <summary>
  103. Sets the notification configuration for this bucket
  104. </summary>
  105. <param name="args">
  106. SetBucketNotificationsArgs Arguments Object with information like Bucket name, notification object
  107. with configuration to set
  108. </param>
  109. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  110. <returns></returns>
  111. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  112. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  113. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  114. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  115. </member>
  116. <member name="M:Minio.MinioClient.RemoveAllBucketNotificationsAsync(Minio.DataModel.Args.RemoveAllBucketNotificationsArgs,System.Threading.CancellationToken)">
  117. <summary>
  118. Removes all bucket notification configurations stored on the server.
  119. </summary>
  120. <param name="args">RemoveAllBucketNotificationsArgs Arguments Object with information like Bucket name</param>
  121. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  122. <returns></returns>
  123. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  124. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  125. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  126. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  127. </member>
  128. <member name="M:Minio.MinioClient.ListenBucketNotificationsAsync(Minio.DataModel.Args.ListenBucketNotificationsArgs,System.Threading.CancellationToken)">
  129. <summary>
  130. Subscribes to bucket change notifications (a Minio-only extension)
  131. </summary>
  132. <param name="args">
  133. ListenBucketNotificationsArgs Arguments Object with information like Bucket name, listen events,
  134. prefix filter keys, suffix filter keys
  135. </param>
  136. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  137. <returns>An observable of JSON-based notification events</returns>
  138. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  139. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  140. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  141. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  142. </member>
  143. <member name="M:Minio.MinioClient.GetBucketTagsAsync(Minio.DataModel.Args.GetBucketTagsArgs,System.Threading.CancellationToken)">
  144. <summary>
  145. Gets Tagging values set for this bucket
  146. </summary>
  147. <param name="args">GetBucketTagsArgs Arguments Object with information like Bucket name</param>
  148. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  149. <returns>Tagging Object with key-value tag pairs</returns>
  150. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  151. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  152. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  153. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  154. </member>
  155. <member name="M:Minio.MinioClient.SetBucketEncryptionAsync(Minio.DataModel.Args.SetBucketEncryptionArgs,System.Threading.CancellationToken)">
  156. <summary>
  157. Sets the Encryption Configuration for the mentioned bucket.
  158. </summary>
  159. <param name="args">SetBucketEncryptionArgs Arguments Object with information like Bucket name, encryption config</param>
  160. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  161. <returns> Task </returns>
  162. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  163. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  164. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  165. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  166. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  167. </member>
  168. <member name="M:Minio.MinioClient.GetBucketEncryptionAsync(Minio.DataModel.Args.GetBucketEncryptionArgs,System.Threading.CancellationToken)">
  169. <summary>
  170. Returns the Encryption Configuration for the mentioned bucket.
  171. </summary>
  172. <param name="args">GetBucketEncryptionArgs Arguments Object encapsulating information like Bucket name</param>
  173. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  174. <returns> An object of type ServerSideEncryptionConfiguration </returns>
  175. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  176. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  177. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  178. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  179. </member>
  180. <member name="M:Minio.MinioClient.RemoveBucketEncryptionAsync(Minio.DataModel.Args.RemoveBucketEncryptionArgs,System.Threading.CancellationToken)">
  181. <summary>
  182. Removes the Encryption Configuration for the mentioned bucket.
  183. </summary>
  184. <param name="args">RemoveBucketEncryptionArgs Arguments Object encapsulating information like Bucket name</param>
  185. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  186. <returns> Task </returns>
  187. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  188. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  189. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  190. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  191. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  192. </member>
  193. <member name="M:Minio.MinioClient.SetBucketTagsAsync(Minio.DataModel.Args.SetBucketTagsArgs,System.Threading.CancellationToken)">
  194. <summary>
  195. Sets the Tagging values for this bucket
  196. </summary>
  197. <param name="args">SetBucketTagsArgs Arguments Object with information like Bucket name, tag key-value pairs</param>
  198. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  199. <returns></returns>
  200. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  201. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  202. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  203. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  204. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  205. </member>
  206. <member name="M:Minio.MinioClient.RemoveBucketTagsAsync(Minio.DataModel.Args.RemoveBucketTagsArgs,System.Threading.CancellationToken)">
  207. <summary>
  208. Removes Tagging values stored for the bucket.
  209. </summary>
  210. <param name="args">RemoveBucketTagsArgs Arguments Object with information like Bucket name</param>
  211. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  212. <returns></returns>
  213. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  214. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  215. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  216. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  217. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  218. </member>
  219. <member name="M:Minio.MinioClient.SetObjectLockConfigurationAsync(Minio.DataModel.Args.SetObjectLockConfigurationArgs,System.Threading.CancellationToken)">
  220. <summary>
  221. Sets the Object Lock Configuration on this bucket
  222. </summary>
  223. <param name="args">
  224. SetObjectLockConfigurationArgs Arguments Object with information like Bucket name, object lock
  225. configuration to set
  226. </param>
  227. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  228. <returns></returns>
  229. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  230. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  231. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  232. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  233. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  234. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  235. </member>
  236. <member name="M:Minio.MinioClient.GetObjectLockConfigurationAsync(Minio.DataModel.Args.GetObjectLockConfigurationArgs,System.Threading.CancellationToken)">
  237. <summary>
  238. Gets the Object Lock Configuration on this bucket
  239. </summary>
  240. <param name="args">GetObjectLockConfigurationArgs Arguments Object with information like Bucket name</param>
  241. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  242. <returns>ObjectLockConfiguration object</returns>
  243. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  244. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  245. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  246. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  247. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  248. </member>
  249. <member name="M:Minio.MinioClient.RemoveObjectLockConfigurationAsync(Minio.DataModel.Args.RemoveObjectLockConfigurationArgs,System.Threading.CancellationToken)">
  250. <summary>
  251. Removes the Object Lock Configuration on this bucket
  252. </summary>
  253. <param name="args">RemoveObjectLockConfigurationArgs Arguments Object with information like Bucket name</param>
  254. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  255. <returns></returns>
  256. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  257. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  258. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  259. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  260. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  261. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  262. </member>
  263. <member name="M:Minio.MinioClient.SetBucketLifecycleAsync(Minio.DataModel.Args.SetBucketLifecycleArgs,System.Threading.CancellationToken)">
  264. <summary>
  265. Sets the Lifecycle configuration for this bucket
  266. </summary>
  267. <param name="args">
  268. SetBucketLifecycleArgs Arguments Object with information like Bucket name, Lifecycle configuration
  269. object
  270. </param>
  271. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  272. <returns></returns>
  273. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  274. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  275. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  276. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  277. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  278. </member>
  279. <member name="M:Minio.MinioClient.GetBucketLifecycleAsync(Minio.DataModel.Args.GetBucketLifecycleArgs,System.Threading.CancellationToken)">
  280. <summary>
  281. Gets Lifecycle configuration set for this bucket returned in an object
  282. </summary>
  283. <param name="args">GetBucketLifecycleArgs Arguments Object with information like Bucket name</param>
  284. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  285. <returns>LifecycleConfiguration Object with the lifecycle configuration</returns>
  286. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  287. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  288. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  289. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  290. </member>
  291. <member name="M:Minio.MinioClient.RemoveBucketLifecycleAsync(Minio.DataModel.Args.RemoveBucketLifecycleArgs,System.Threading.CancellationToken)">
  292. <summary>
  293. Removes Lifecycle configuration stored for the bucket.
  294. </summary>
  295. <param name="args">RemoveBucketLifecycleArgs Arguments Object with information like Bucket name</param>
  296. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  297. <returns></returns>
  298. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  299. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  300. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  301. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  302. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  303. </member>
  304. <member name="M:Minio.MinioClient.GetBucketReplicationAsync(Minio.DataModel.Args.GetBucketReplicationArgs,System.Threading.CancellationToken)">
  305. <summary>
  306. Get Replication configuration for the bucket
  307. </summary>
  308. <param name="args">GetBucketReplicationArgs Arguments Object with information like Bucket name</param>
  309. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  310. <returns>Replication configuration object</returns>
  311. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  312. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  313. <exception cref="T:Minio.Exceptions.MissingBucketReplicationConfigurationException">When bucket replication configuration is not set</exception>
  314. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  315. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  316. </member>
  317. <member name="M:Minio.MinioClient.SetBucketReplicationAsync(Minio.DataModel.Args.SetBucketReplicationArgs,System.Threading.CancellationToken)">
  318. <summary>
  319. Set the Replication configuration for the bucket
  320. </summary>
  321. <param name="args">
  322. SetBucketReplicationArgs Arguments Object with information like Bucket name, Replication
  323. Configuration object
  324. </param>
  325. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  326. <returns></returns>
  327. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  328. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  329. <exception cref="T:Minio.Exceptions.MissingBucketReplicationConfigurationException">When bucket replication configuration is not set</exception>
  330. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  331. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  332. </member>
  333. <member name="M:Minio.MinioClient.RemoveBucketReplicationAsync(Minio.DataModel.Args.RemoveBucketReplicationArgs,System.Threading.CancellationToken)">
  334. <summary>
  335. Remove Replication configuration for the bucket.
  336. </summary>
  337. <param name="args">RemoveBucketReplicationArgs Arguments Object with information like Bucket name</param>
  338. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  339. <returns></returns>
  340. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  341. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  342. <exception cref="T:Minio.Exceptions.MissingBucketReplicationConfigurationException">When bucket replication configuration is not set</exception>
  343. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  344. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  345. </member>
  346. <member name="M:Minio.MinioClient.ListenBucketNotificationsAsync(System.String,System.Collections.Generic.IList{Minio.DataModel.Notification.EventType},System.String,System.String,System.Threading.CancellationToken)">
  347. <summary>
  348. Subscribes to bucket change notifications (a Minio-only extension)
  349. </summary>
  350. <param name="bucketName">Bucket to get notifications from</param>
  351. <param name="events">Events to listen for</param>
  352. <param name="prefix">Filter keys starting with this prefix</param>
  353. <param name="suffix">Filter keys ending with this suffix</param>
  354. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  355. <returns>An observable of JSON-based notification events</returns>
  356. </member>
  357. <member name="M:Minio.MinioClient.GetPolicyAsync(Minio.DataModel.Args.GetPolicyArgs,System.Threading.CancellationToken)">
  358. <summary>
  359. Returns current policy stored on the server for this bucket
  360. </summary>
  361. <param name="args">GetPolicyArgs object has information like Bucket name.</param>
  362. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  363. <returns>Task that returns the Bucket policy as a json string</returns>
  364. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucketName is invalid</exception>
  365. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  366. <exception cref="T:Minio.Exceptions.UnexpectedMinioException">When a policy is not set</exception>
  367. </member>
  368. <member name="M:Minio.MinioClient.SetPolicyAsync(Minio.DataModel.Args.SetPolicyArgs,System.Threading.CancellationToken)">
  369. <summary>
  370. Sets the current bucket policy
  371. </summary>
  372. <param name="args">SetPolicyArgs object has information like Bucket name and the policy to set in Json format</param>
  373. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  374. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucketName is invalid</exception>
  375. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  376. <exception cref="T:Minio.Exceptions.UnexpectedMinioException">When a policy is not set</exception>
  377. <returns>Task to set a policy</returns>
  378. </member>
  379. <member name="M:Minio.MinioClient.RemovePolicyAsync(Minio.DataModel.Args.RemovePolicyArgs,System.Threading.CancellationToken)">
  380. <summary>
  381. Removes the current bucket policy
  382. </summary>
  383. <param name="args">RemovePolicyArgs object has information like Bucket name</param>
  384. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  385. <returns>Task to set a policy</returns>
  386. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucketName is invalid</exception>
  387. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  388. <exception cref="T:Minio.Exceptions.UnexpectedMinioException">When a policy is not set</exception>
  389. </member>
  390. <member name="M:Minio.MinioClient.GetObjectListAsync(Minio.DataModel.Args.GetObjectListArgs,System.Threading.CancellationToken)">
  391. <summary>
  392. Gets the list of objects in the bucket filtered by prefix
  393. </summary>
  394. <param name="args">
  395. GetObjectListArgs Arguments Object with information like Bucket name, prefix, delimiter, marker,
  396. versions(get version IDs of the objects)
  397. </param>
  398. <returns>Task with a tuple populated with objects</returns>
  399. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  400. </member>
  401. <member name="M:Minio.MinioClient.GetObjectVersionsListAsync(Minio.DataModel.Args.GetObjectListArgs,System.Threading.CancellationToken)">
  402. <summary>
  403. Gets the list of objects along with version IDs in the bucket filtered by prefix
  404. </summary>
  405. <param name="args">
  406. GetObjectListArgs Arguments Object with information like Bucket name, prefix, delimiter, marker,
  407. versions(get version IDs of the objects)
  408. </param>
  409. <returns>Task with a tuple populated with objects</returns>
  410. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  411. </member>
  412. <member name="M:Minio.MinioClient.GetObjectListAsync(System.String,System.String,System.String,System.String,System.Threading.CancellationToken)">
  413. <summary>
  414. Gets the list of objects in the bucket filtered by prefix
  415. </summary>
  416. <param name="bucketName">Bucket to list objects from</param>
  417. <param name="prefix">Filters all objects starting with a given prefix</param>
  418. <param name="delimiter">Delimit the output upto this character</param>
  419. <param name="marker">marks location in the iterator sequence</param>
  420. <returns>Task with a tuple populated with objects</returns>
  421. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  422. </member>
  423. <member name="M:Minio.MinioClient.GetObjectAsync(Minio.DataModel.Args.GetObjectArgs,System.Threading.CancellationToken)">
  424. <summary>
  425. Get an object. The object will be streamed to the callback given by the user.
  426. </summary>
  427. <param name="args">
  428. GetObjectArgs Arguments Object encapsulates information like - bucket name, object name, server-side
  429. encryption object, action stream, length, offset
  430. </param>
  431. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  432. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  433. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  434. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  435. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  436. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  437. <exception cref="T:System.IO.DirectoryNotFoundException">If the directory to copy to is not found</exception>
  438. </member>
  439. <member name="M:Minio.MinioClient.SelectObjectContentAsync(Minio.DataModel.Args.SelectObjectContentArgs,System.Threading.CancellationToken)">
  440. <summary>
  441. Select an object's content. The object will be streamed to the callback given by the user.
  442. </summary>
  443. <param name="args">
  444. SelectObjectContentArgs Arguments Object which encapsulates bucket name, object name, Select Object
  445. Options
  446. </param>
  447. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  448. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  449. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  450. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  451. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  452. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  453. </member>
  454. <member name="M:Minio.MinioClient.ListIncompleteUploads(Minio.DataModel.Args.ListIncompleteUploadsArgs,System.Threading.CancellationToken)">
  455. <summary>
  456. Lists all incomplete uploads in a given bucket and prefix recursively
  457. </summary>
  458. <param name="args">ListIncompleteUploadsArgs Arguments Object which encapsulates bucket name, prefix, recursive</param>
  459. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  460. <returns>A lazily populated list of incomplete uploads</returns>
  461. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  462. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  463. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  464. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  465. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  466. </member>
  467. <member name="M:Minio.MinioClient.RemoveIncompleteUploadAsync(Minio.DataModel.Args.RemoveIncompleteUploadArgs,System.Threading.CancellationToken)">
  468. <summary>
  469. Remove incomplete uploads from a given bucket and objectName
  470. </summary>
  471. <param name="args">RemoveIncompleteUploadArgs Arguments Object which encapsulates bucket, object names</param>
  472. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  473. <returns></returns>
  474. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  475. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  476. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  477. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  478. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  479. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  480. </member>
  481. <member name="M:Minio.MinioClient.PresignedGetObjectAsync(Minio.DataModel.Args.PresignedGetObjectArgs)">
  482. <summary>
  483. Presigned get url - returns a presigned url to access an object's data without credentials.URL can have a maximum
  484. expiry of
  485. up to 7 days or a minimum of 1 second.Additionally, you can override a set of response headers using reqParams.
  486. </summary>
  487. <param name="args">
  488. PresignedGetObjectArgs Arguments object encapsulating bucket and object names, expiry time, response
  489. headers, request date
  490. </param>
  491. <returns></returns>
  492. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  493. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  494. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  495. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  496. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  497. </member>
  498. <member name="M:Minio.MinioClient.PresignedPostPolicyAsync(Minio.DataModel.Args.PresignedPostPolicyArgs)">
  499. <summary>
  500. Presigned post policy
  501. </summary>
  502. <param name="args">PresignedPostPolicyArgs Arguments object encapsulating Policy, Expiry, Region, </param>
  503. <returns>Tuple of URI and Policy Form data</returns>
  504. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  505. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  506. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  507. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  508. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  509. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  510. </member>
  511. <member name="M:Minio.MinioClient.PresignedPutObjectAsync(Minio.DataModel.Args.PresignedPutObjectArgs)">
  512. <summary>
  513. Presigned Put url -returns a presigned url to upload an object without credentials.URL can have a maximum expiry of
  514. upto 7 days or a minimum of 1 second.
  515. </summary>
  516. <param name="args">PresignedPutObjectArgs Arguments Object which encapsulates bucket, object names, expiry</param>
  517. <returns></returns>
  518. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  519. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  520. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  521. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  522. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  523. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  524. </member>
  525. <member name="M:Minio.MinioClient.GetObjectLegalHoldAsync(Minio.DataModel.Args.GetObjectLegalHoldArgs,System.Threading.CancellationToken)">
  526. <summary>
  527. Get the configuration object for Legal Hold Status
  528. </summary>
  529. <param name="args">
  530. GetObjectLegalHoldArgs Arguments Object which has object identifier information - bucket name,
  531. object name, version ID
  532. </param>
  533. <param name="cancellationToken">Optional cancellation token to cancel the operation </param>
  534. <returns> True if Legal Hold is ON, false otherwise </returns>
  535. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  536. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  537. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  538. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  539. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  540. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  541. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  542. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  543. </member>
  544. <member name="M:Minio.MinioClient.SetObjectLegalHoldAsync(Minio.DataModel.Args.SetObjectLegalHoldArgs,System.Threading.CancellationToken)">
  545. <summary>
  546. Set the Legal Hold Status using the related configuration
  547. </summary>
  548. <param name="args">
  549. SetObjectLegalHoldArgs Arguments Object which has object identifier information - bucket name,
  550. object name, version ID
  551. </param>
  552. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  553. <returns> Task </returns>
  554. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  555. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  556. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  557. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  558. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  559. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  560. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  561. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  562. </member>
  563. <member name="M:Minio.MinioClient.GetObjectTagsAsync(Minio.DataModel.Args.GetObjectTagsArgs,System.Threading.CancellationToken)">
  564. <summary>
  565. Gets Tagging values set for this object
  566. </summary>
  567. <param name="args"> GetObjectTagsArgs Arguments Object with information like Bucket, Object name, (optional)version Id</param>
  568. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  569. <returns>Tagging Object with key-value tag pairs</returns>
  570. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  571. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  572. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  573. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  574. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  575. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  576. </member>
  577. <member name="M:Minio.MinioClient.RemoveObjectAsync(Minio.DataModel.Args.RemoveObjectArgs,System.Threading.CancellationToken)">
  578. <summary>
  579. Removes an object with given name in specific bucket
  580. </summary>
  581. <param name="args">
  582. RemoveObjectArgs Arguments Object encapsulates information like - bucket name, object name, optional
  583. list of versions to be deleted
  584. </param>
  585. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  586. <returns>Task</returns>
  587. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  588. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  589. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  590. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  591. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  592. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  593. </member>
  594. <member name="M:Minio.MinioClient.RemoveObjectsAsync(Minio.DataModel.Args.RemoveObjectsArgs,System.Threading.CancellationToken)">
  595. <summary>
  596. Removes list of objects from bucket
  597. </summary>
  598. <param name="args">
  599. RemoveObjectsArgs Arguments Object encapsulates information like - bucket name, List of objects,
  600. optional list of versions (for each object) to be deleted
  601. </param>
  602. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  603. <returns>Observable that returns delete error while deleting objects if any</returns>
  604. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  605. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  606. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  607. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  608. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  609. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  610. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  611. </member>
  612. <member name="M:Minio.MinioClient.SetObjectTagsAsync(Minio.DataModel.Args.SetObjectTagsArgs,System.Threading.CancellationToken)">
  613. <summary>
  614. Sets the Tagging values for this object
  615. </summary>
  616. <param name="args">
  617. SetObjectTagsArgs Arguments Object with information like Bucket name,Object name, (optional)version
  618. Id, tag key-value pairs
  619. </param>
  620. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  621. <returns></returns>
  622. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  623. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  624. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  625. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  626. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  627. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  628. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  629. </member>
  630. <member name="M:Minio.MinioClient.RemoveObjectTagsAsync(Minio.DataModel.Args.RemoveObjectTagsArgs,System.Threading.CancellationToken)">
  631. <summary>
  632. Removes Tagging values stored for the object
  633. </summary>
  634. <param name="args">RemoveObjectTagsArgs Arguments Object with information like Bucket name</param>
  635. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  636. <returns></returns>
  637. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  638. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  639. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  640. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  641. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  642. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  643. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  644. </member>
  645. <member name="M:Minio.MinioClient.SetObjectRetentionAsync(Minio.DataModel.Args.SetObjectRetentionArgs,System.Threading.CancellationToken)">
  646. <summary>
  647. Set the Retention using the configuration object
  648. </summary>
  649. <param name="args">
  650. SetObjectRetentionArgs Arguments Object which has object identifier information - bucket name,
  651. object name, version ID
  652. </param>
  653. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  654. <returns> Task </returns>
  655. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  656. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  657. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  658. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  659. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  660. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  661. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  662. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  663. </member>
  664. <member name="M:Minio.MinioClient.GetObjectRetentionAsync(Minio.DataModel.Args.GetObjectRetentionArgs,System.Threading.CancellationToken)">
  665. <summary>
  666. Get the Retention configuration for the object
  667. </summary>
  668. <param name="args">
  669. GetObjectRetentionArgs Arguments Object which has object identifier information - bucket name,
  670. object name, version ID
  671. </param>
  672. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  673. <returns> Task </returns>
  674. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  675. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  676. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  677. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  678. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  679. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  680. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  681. </member>
  682. <member name="M:Minio.MinioClient.ClearObjectRetentionAsync(Minio.DataModel.Args.ClearObjectRetentionArgs,System.Threading.CancellationToken)">
  683. <summary>
  684. Clears the Retention configuration for the object
  685. </summary>
  686. <param name="args">
  687. ClearObjectRetentionArgs Arguments Object which has object identifier information - bucket name,
  688. object name, version ID
  689. </param>
  690. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  691. <returns> Task </returns>
  692. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  693. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  694. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  695. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  696. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  697. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  698. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  699. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  700. </member>
  701. <member name="M:Minio.MinioClient.PutObjectAsync(Minio.DataModel.Args.PutObjectArgs,System.Threading.CancellationToken)">
  702. <summary>
  703. Creates object in a bucket fom input stream or filename.
  704. </summary>
  705. <param name="args">
  706. PutObjectArgs Arguments object encapsulating bucket name, object name, file name, object data
  707. stream, object size, content type.
  708. </param>
  709. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  710. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  711. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  712. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  713. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  714. <exception cref="T:System.IO.FileNotFoundException">If the file to copy from not found</exception>
  715. <exception cref="T:System.ObjectDisposedException">The file stream has been disposed</exception>
  716. <exception cref="T:System.NotSupportedException">The file stream cannot be read from</exception>
  717. <exception cref="T:System.InvalidOperationException">The file stream is currently in a read operation</exception>
  718. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted PUT operation, Access is denied if the key is wrong</exception>
  719. </member>
  720. <member name="M:Minio.MinioClient.CopyObjectAsync(Minio.DataModel.Args.CopyObjectArgs,System.Threading.CancellationToken)">
  721. <summary>
  722. Copy a source object into a new destination object.
  723. </summary>
  724. <param name="args">
  725. CopyObjectArgs Arguments Object which encapsulates bucket name, object name, destination bucket,
  726. destination object names, Copy conditions object, metadata, SSE source, destination objects
  727. </param>
  728. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  729. <returns></returns>
  730. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  731. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  732. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  733. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  734. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  735. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted copy operation, Access is denied if the key is wrong</exception>
  736. </member>
  737. <member name="M:Minio.MinioClient.PresignedPostPolicyAsync(Minio.DataModel.PostPolicy)">
  738. <summary>
  739. Presigned post policy
  740. </summary>
  741. <param name="policy"></param>
  742. <returns></returns>
  743. </member>
  744. <member name="M:Minio.MinioClient.StatObjectAsync(Minio.DataModel.Args.StatObjectArgs,System.Threading.CancellationToken)">
  745. <summary>
  746. Tests the object's existence and returns metadata about existing objects.
  747. </summary>
  748. <param name="args">
  749. StatObjectArgs Arguments Object encapsulates information like - bucket name, object name,
  750. server-side encryption object
  751. </param>
  752. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  753. <returns>Facts about the object</returns>
  754. </member>
  755. <member name="M:Minio.MinioClient.GetMultipartUploadsListAsync(Minio.DataModel.Args.GetMultipartUploadsListArgs,System.Threading.CancellationToken)">
  756. <summary>
  757. Get list of multi-part uploads matching particular uploadIdMarker
  758. </summary>
  759. <param name="args">GetMultipartUploadsListArgs Arguments Object which encapsulates bucket name, prefix, recursive</param>
  760. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  761. <returns></returns>
  762. </member>
  763. <member name="M:Minio.MinioClient.RemoveUploadAsync(Minio.DataModel.Args.RemoveUploadArgs,System.Threading.CancellationToken)">
  764. <summary>
  765. Remove object with matching uploadId from bucket
  766. </summary>
  767. <param name="args">RemoveUploadArgs Arguments Object which encapsulates bucket, object names, upload Id</param>
  768. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  769. <returns></returns>
  770. </member>
  771. <member name="M:Minio.MinioClient.PutObjectSinglePartAsync(Minio.DataModel.Args.PutObjectArgs,System.Threading.CancellationToken)">
  772. <summary>
  773. Upload object part to bucket for particular uploadId
  774. </summary>
  775. <param name="args">
  776. PutObjectArgs encapsulates bucket name, object name, upload id, part number, object data(body),
  777. Headers, SSE Headers
  778. </param>
  779. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  780. <returns></returns>
  781. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  782. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  783. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  784. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  785. <exception cref="T:System.ObjectDisposedException">The file stream has been disposed</exception>
  786. <exception cref="T:System.NotSupportedException">The file stream cannot be read from</exception>
  787. <exception cref="T:System.InvalidOperationException">The file stream is currently in a read operation</exception>
  788. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted PUT operation, Access is denied if the key is wrong</exception>
  789. </member>
  790. <member name="M:Minio.MinioClient.PutObjectPartAsync(Minio.DataModel.Args.PutObjectPartArgs,System.Threading.CancellationToken)">
  791. <summary>
  792. Upload object in multiple parts. Private Helper function
  793. </summary>
  794. <param name="args">PutObjectPartArgs encapsulates bucket name, object name, upload id, part number, object data(body)</param>
  795. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  796. <returns></returns>
  797. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  798. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  799. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  800. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  801. <exception cref="T:System.ObjectDisposedException">The file stream has been disposed</exception>
  802. <exception cref="T:System.NotSupportedException">The file stream cannot be read from</exception>
  803. <exception cref="T:System.InvalidOperationException">The file stream is currently in a read operation</exception>
  804. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted PUT operation, Access is denied if the key is wrong</exception>
  805. </member>
  806. <member name="M:Minio.MinioClient.MultipartCopyUploadAsync(Minio.DataModel.Args.MultipartCopyUploadArgs,System.Threading.CancellationToken)">
  807. <summary>
  808. Make a multi part copy upload for objects larger than 5GB or if CopyCondition specifies a byte range.
  809. </summary>
  810. <param name="args">
  811. MultipartCopyUploadArgs Arguments object encapsulating destination and source bucket, object names,
  812. copy conditions, size, metadata, SSE
  813. </param>
  814. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  815. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  816. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  817. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  818. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  819. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  820. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted copy operation, Access is denied if the key is wrong</exception>
  821. </member>
  822. <member name="M:Minio.MinioClient.NewMultipartUploadAsync(Minio.DataModel.Args.NewMultipartUploadPutArgs,System.Threading.CancellationToken)">
  823. <summary>
  824. Start a new multi-part upload request
  825. </summary>
  826. <param name="args">
  827. NewMultipartUploadPutArgs arguments object encapsulating bucket name, object name, Headers, SSE
  828. Headers
  829. </param>
  830. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  831. <returns></returns>
  832. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  833. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  834. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  835. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  836. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  837. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted copy operation, Access is denied if the key is wrong</exception>
  838. </member>
  839. <member name="M:Minio.MinioClient.NewMultipartUploadAsync(Minio.DataModel.Args.NewMultipartUploadCopyArgs,System.Threading.CancellationToken)">
  840. <summary>
  841. Start a new multi-part copy upload request
  842. </summary>
  843. <param name="args">
  844. NewMultipartUploadCopyArgs arguments object encapsulating bucket name, object name, Headers, SSE
  845. Headers
  846. </param>
  847. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  848. <returns></returns>
  849. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  850. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  851. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  852. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  853. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  854. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted copy operation, Access is denied if the key is wrong</exception>
  855. </member>
  856. <member name="M:Minio.MinioClient.CopyObjectRequestAsync(Minio.DataModel.Args.CopyObjectRequestArgs,System.Threading.CancellationToken)">
  857. <summary>
  858. Create the copy request, execute it and return the copy result.
  859. </summary>
  860. <param name="args"> CopyObjectRequestArgs Arguments Object encapsulating </param>
  861. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  862. </member>
  863. <member name="M:Minio.MinioClient.CompleteMultipartUploadAsync(Minio.DataModel.Args.CompleteMultipartUploadArgs,System.Threading.CancellationToken)">
  864. <summary>
  865. Internal method to complete multi part upload of object to server.
  866. </summary>
  867. <param name="args">CompleteMultipartUploadArgs Arguments object with bucket name, object name, upload id, Etags</param>
  868. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  869. <returns></returns>
  870. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  871. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  872. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  873. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  874. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  875. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted copy operation, Access is denied if the key is wrong</exception>
  876. </member>
  877. <member name="M:Minio.MinioClient.ReadFullAsync(System.IO.Stream,System.Int32)">
  878. <summary>
  879. Advances in the stream upto currentPartSize or End of Stream
  880. </summary>
  881. <param name="data"></param>
  882. <param name="currentPartSize"></param>
  883. <returns>bytes read in a byte array</returns>
  884. </member>
  885. <member name="M:Minio.MinioClient.GetObjectHelper(Minio.DataModel.Args.GetObjectArgs,System.Threading.CancellationToken)">
  886. <summary>
  887. private helper method to remove list of objects from bucket
  888. </summary>
  889. <param name="args">GetObjectArgs Arguments Object encapsulates information like - bucket name, object name etc </param>
  890. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  891. </member>
  892. <member name="M:Minio.MinioClient.GetObjectFileAsync(Minio.DataModel.Args.GetObjectArgs,Minio.DataModel.ObjectStat,System.Threading.CancellationToken)">
  893. <summary>
  894. private helper method return the specified object from the bucket
  895. </summary>
  896. <param name="args">GetObjectArgs Arguments Object encapsulates information like - bucket name, object name etc </param>
  897. <param name="objectStat"> ObjectStat object encapsulates information like - object name, size, etag etc </param>
  898. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  899. </member>
  900. <member name="M:Minio.MinioClient.GetObjectStreamAsync(Minio.DataModel.Args.GetObjectArgs,System.Threading.CancellationToken)">
  901. <summary>
  902. private helper method. It returns the specified portion or full object from the bucket
  903. </summary>
  904. <param name="args">GetObjectArgs Arguments Object encapsulates information like - bucket name, object name etc </param>
  905. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  906. </member>
  907. <member name="M:Minio.MinioClient.RemoveBucketObjectsAsync(Minio.DataModel.Args.RemoveObjectsArgs,System.Threading.CancellationToken)">
  908. <summary>
  909. private helper method to remove list of objects from bucket
  910. </summary>
  911. <param name="args">
  912. RemoveObjectsArgs Arguments Object encapsulates information like - bucket name, List of objects,
  913. optional list of versions (for each object) to be deleted
  914. </param>
  915. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  916. <returns></returns>
  917. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  918. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  919. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  920. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  921. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  922. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  923. </member>
  924. <member name="M:Minio.MinioClient.CallRemoveObjectVersions(Minio.DataModel.Args.RemoveObjectsArgs,System.Collections.Generic.IList{System.Tuple{System.String,System.String}},System.Collections.Generic.List{Minio.Exceptions.DeleteError},System.Threading.CancellationToken)">
  925. <summary>
  926. private helper method to call remove objects function
  927. </summary>
  928. <param name="args">
  929. RemoveObjectsArgs Arguments Object encapsulates information like - bucket name, List of objects,
  930. optional version Id list
  931. </param>
  932. <param name="objVersions">List of Tuples. Each tuple is Object name to List of Version IDs to be deleted</param>
  933. <param name="fullErrorsList">
  934. Full List of DeleteError objects. The error list from this call will be added to the full
  935. list.
  936. </param>
  937. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  938. <returns></returns>
  939. </member>
  940. <member name="M:Minio.MinioClient.CallRemoveObjects(Minio.DataModel.Args.RemoveObjectsArgs,System.Collections.Generic.IList{System.String},System.Collections.Generic.List{Minio.Exceptions.DeleteError},System.Threading.CancellationToken)">
  941. <summary>
  942. private helper method to call function to remove objects/version items in iterations of 1000 each from bucket
  943. </summary>
  944. <param name="args">
  945. RemoveObjectsArgs Arguments Object encapsulates information like - bucket name, List of objects,
  946. optional list of versions (for each object) to be deleted
  947. </param>
  948. <param name="objNames">List of Object names to be deleted</param>
  949. <param name="fullErrorsList">
  950. Full List of DeleteError objects. The error list from this call will be added to the full
  951. list.
  952. </param>
  953. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  954. <returns></returns>
  955. </member>
  956. <member name="M:Minio.MinioClient.RemoveObjectVersionsHelper(Minio.DataModel.Args.RemoveObjectsArgs,System.Collections.Generic.List{Minio.Exceptions.DeleteError},System.Threading.CancellationToken)">
  957. <summary>
  958. private helper method to remove objects/version items in iterations of 1000 each from bucket
  959. </summary>
  960. <param name="args">
  961. RemoveObjectsArgs Arguments Object encapsulates information like - bucket name, List of objects,
  962. optional list of versions (for each object) to be deleted
  963. </param>
  964. <param name="fullErrorsList">
  965. Full List of DeleteError objects. The error list from this call will be added to the full
  966. list.
  967. </param>
  968. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  969. <returns></returns>
  970. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  971. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  972. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  973. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  974. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  975. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  976. </member>
  977. <member name="M:Minio.MinioClient.RemoveObjectsHelper(Minio.DataModel.Args.RemoveObjectsArgs,System.Collections.Generic.IList{Minio.Exceptions.DeleteError},System.Threading.CancellationToken)">
  978. <summary>
  979. private helper method to remove objects in iterations of 1000 each from bucket
  980. </summary>
  981. <param name="args">
  982. RemoveObjectsArgs Arguments Object encapsulates information like - bucket name, List of objects,
  983. optional list of versions (for each object) to be deleted
  984. </param>
  985. <param name="fullErrorsList">
  986. Full List of DeleteError objects. The error list from this call will be added to the full
  987. list.
  988. </param>
  989. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  990. <returns></returns>
  991. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  992. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  993. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  994. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  995. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  996. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  997. </member>
  998. <member name="M:Minio.MinioClient.#ctor">
  999. <summary>
  1000. Creates and returns an MinIO Client
  1001. </summary>
  1002. <returns>Client with no arguments to be used with other builder methods</returns>
  1003. </member>
  1004. <member name="P:Minio.MinioClient.DefaultErrorHandler">
  1005. <summary>
  1006. Default error handling delegate
  1007. </summary>
  1008. </member>
  1009. <member name="M:Minio.MinioClient.WrapperGetAsync(System.Uri)">
  1010. <summary>
  1011. Runs httpClient's GetAsync method
  1012. </summary>
  1013. </member>
  1014. <member name="M:Minio.MinioClient.WrapperPutAsync(System.Uri,System.Net.Http.StreamContent)">
  1015. <summary>
  1016. Runs httpClient's PutObjectAsync method
  1017. </summary>
  1018. </member>
  1019. <member name="M:Minio.MinioClient.SetTraceOn(Minio.Handlers.IRequestLogger)">
  1020. <summary>
  1021. Sets HTTP tracing On.Writes output to Console
  1022. </summary>
  1023. </member>
  1024. <member name="M:Minio.MinioClient.SetTraceOff">
  1025. <summary>
  1026. Sets HTTP tracing Off.
  1027. </summary>
  1028. </member>
  1029. <member name="M:Minio.MinioClient.ParseError(Minio.DataModel.Result.ResponseResult)">
  1030. <summary>
  1031. Parse response errors if any and return relevant error messages
  1032. </summary>
  1033. <param name="response"></param>
  1034. </member>
  1035. <member name="M:Minio.ApiEndpoints.IBucketOperations.MakeBucketAsync(Minio.DataModel.Args.MakeBucketArgs,System.Threading.CancellationToken)">
  1036. <summary>
  1037. Create a bucket with the given name.
  1038. </summary>
  1039. <param name="args">MakeBucketArgs Arguments Object that has bucket info like name, location. etc</param>
  1040. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1041. <returns> Task </returns>
  1042. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1043. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucketName is invalid</exception>
  1044. <exception cref="T:System.NotImplementedException">When object-lock or another extension is not implemented</exception>
  1045. </member>
  1046. <member name="M:Minio.ApiEndpoints.IBucketOperations.ListBucketsAsync(System.Threading.CancellationToken)">
  1047. <summary>
  1048. List all objects in a bucket
  1049. </summary>
  1050. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1051. <returns>Task with an iterator lazily populated with objects</returns>
  1052. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1053. </member>
  1054. <member name="M:Minio.ApiEndpoints.IBucketOperations.BucketExistsAsync(Minio.DataModel.Args.BucketExistsArgs,System.Threading.CancellationToken)">
  1055. <summary>
  1056. Check if a private bucket with the given name exists.
  1057. </summary>
  1058. <param name="args">BucketExistsArgs Arguments Object which has bucket identifier information - bucket name, region</param>
  1059. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1060. <returns> Task </returns>
  1061. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1062. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1063. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1064. </member>
  1065. <member name="M:Minio.ApiEndpoints.IBucketOperations.RemoveBucketAsync(Minio.DataModel.Args.RemoveBucketArgs,System.Threading.CancellationToken)">
  1066. <summary>
  1067. Remove the bucket with the given name.
  1068. </summary>
  1069. <param name="args">RemoveBucketArgs Arguments Object which has bucket identifier information like bucket name .etc.</param>
  1070. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1071. <returns> Task </returns>
  1072. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1073. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1074. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1075. </member>
  1076. <member name="M:Minio.ApiEndpoints.IBucketOperations.ListObjectsAsync(Minio.DataModel.Args.ListObjectsArgs,System.Threading.CancellationToken)">
  1077. <summary>
  1078. List all objects non-recursively in a bucket with a given prefix, optionally emulating a directory
  1079. </summary>
  1080. <param name="args">
  1081. ListObjectsArgs Arguments Object with information like Bucket name, prefix, recursive listing,
  1082. versioning
  1083. </param>
  1084. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1085. <returns>An observable of items that client can subscribe to</returns>
  1086. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1087. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1088. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1089. <exception cref="T:System.InvalidOperationException">
  1090. For example, if you call ListObjectsAsync on a bucket with versioning
  1091. enabled or object lock enabled
  1092. </exception>
  1093. </member>
  1094. <member name="M:Minio.ApiEndpoints.IBucketOperations.GetBucketNotificationsAsync(Minio.DataModel.Args.GetBucketNotificationsArgs,System.Threading.CancellationToken)">
  1095. <summary>
  1096. Gets notification configuration for this bucket
  1097. </summary>
  1098. <param name="args">GetBucketNotificationsArgs Arguments Object with information like Bucket name</param>
  1099. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1100. <returns></returns>
  1101. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1102. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1103. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1104. </member>
  1105. <member name="M:Minio.ApiEndpoints.IBucketOperations.SetBucketNotificationsAsync(Minio.DataModel.Args.SetBucketNotificationsArgs,System.Threading.CancellationToken)">
  1106. <summary>
  1107. Sets the notification configuration for this bucket
  1108. </summary>
  1109. <param name="args">
  1110. SetBucketNotificationsArgs Arguments Object with information like Bucket name, notification object
  1111. with configuration to set
  1112. </param>
  1113. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1114. <returns></returns>
  1115. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1116. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1117. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1118. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1119. </member>
  1120. <member name="M:Minio.ApiEndpoints.IBucketOperations.RemoveAllBucketNotificationsAsync(Minio.DataModel.Args.RemoveAllBucketNotificationsArgs,System.Threading.CancellationToken)">
  1121. <summary>
  1122. Removes all bucket notification configurations stored on the server.
  1123. </summary>
  1124. <param name="args">RemoveAllBucketNotificationsArgs Arguments Object with information like Bucket name</param>
  1125. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1126. <returns></returns>
  1127. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1128. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1129. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1130. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1131. </member>
  1132. <member name="M:Minio.ApiEndpoints.IBucketOperations.ListenBucketNotificationsAsync(Minio.DataModel.Args.ListenBucketNotificationsArgs,System.Threading.CancellationToken)">
  1133. <summary>
  1134. Subscribes to bucket change notifications (a Minio-only extension)
  1135. </summary>
  1136. <param name="args">
  1137. ListenBucketNotificationsArgs Arguments Object with information like Bucket name, listen events,
  1138. prefix filter keys, suffix fileter keys
  1139. </param>
  1140. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1141. <returns>An observable of JSON-based notification events</returns>
  1142. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1143. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1144. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1145. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1146. </member>
  1147. <member name="M:Minio.ApiEndpoints.IBucketOperations.GetBucketTagsAsync(Minio.DataModel.Args.GetBucketTagsArgs,System.Threading.CancellationToken)">
  1148. <summary>
  1149. Gets Tagging values set for this bucket
  1150. </summary>
  1151. <param name="args">GetBucketTagsArgs Arguments Object with information like Bucket name</param>
  1152. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1153. <returns>Tagging Object with key-value tag pairs</returns>
  1154. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1155. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1156. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1157. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1158. </member>
  1159. <member name="M:Minio.ApiEndpoints.IBucketOperations.SetBucketTagsAsync(Minio.DataModel.Args.SetBucketTagsArgs,System.Threading.CancellationToken)">
  1160. <summary>
  1161. Sets the Tagging values for this bucket
  1162. </summary>
  1163. <param name="args">SetBucketTagsArgs Arguments Object with information like Bucket name, tag key-value pairs</param>
  1164. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1165. <returns></returns>
  1166. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1167. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1168. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1169. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1170. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1171. </member>
  1172. <member name="M:Minio.ApiEndpoints.IBucketOperations.RemoveBucketTagsAsync(Minio.DataModel.Args.RemoveBucketTagsArgs,System.Threading.CancellationToken)">
  1173. <summary>
  1174. Removes Tagging values stored for the bucket.
  1175. </summary>
  1176. <param name="args">RemoveBucketTagsArgs Arguments Object with information like Bucket name</param>
  1177. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1178. <returns></returns>
  1179. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1180. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1181. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1182. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1183. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1184. </member>
  1185. <member name="M:Minio.ApiEndpoints.IBucketOperations.SetObjectLockConfigurationAsync(Minio.DataModel.Args.SetObjectLockConfigurationArgs,System.Threading.CancellationToken)">
  1186. <summary>
  1187. Sets the Object Lock Configuration on this bucket
  1188. </summary>
  1189. <param name="args">
  1190. SetObjectLockConfigurationArgs Arguments Object with information like Bucket name, object lock
  1191. configuration to set
  1192. </param>
  1193. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1194. <returns></returns>
  1195. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1196. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1197. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1198. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  1199. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1200. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1201. </member>
  1202. <member name="M:Minio.ApiEndpoints.IBucketOperations.GetObjectLockConfigurationAsync(Minio.DataModel.Args.GetObjectLockConfigurationArgs,System.Threading.CancellationToken)">
  1203. <summary>
  1204. Gets the Object Lock Configuration on this bucket
  1205. </summary>
  1206. <param name="args">GetObjectLockConfigurationArgs Arguments Object with information like Bucket name</param>
  1207. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1208. <returns>ObjectLockConfiguration object</returns>
  1209. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1210. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1211. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1212. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1213. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  1214. </member>
  1215. <member name="M:Minio.ApiEndpoints.IBucketOperations.RemoveObjectLockConfigurationAsync(Minio.DataModel.Args.RemoveObjectLockConfigurationArgs,System.Threading.CancellationToken)">
  1216. <summary>
  1217. Removes the Object Lock Configuration on this bucket
  1218. </summary>
  1219. <param name="args">RemoveObjectLockConfigurationArgs Arguments Object with information like Bucket name</param>
  1220. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1221. <returns></returns>
  1222. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1223. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1224. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1225. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  1226. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1227. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1228. </member>
  1229. <member name="M:Minio.ApiEndpoints.IBucketOperations.GetVersioningAsync(Minio.DataModel.Args.GetVersioningArgs,System.Threading.CancellationToken)">
  1230. <summary>
  1231. Get Versioning information on the bucket with given bucket name
  1232. </summary>
  1233. <param name="args">GetVersioningArgs takes bucket as argument. </param>
  1234. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1235. <returns> GetVersioningResponse with information populated from REST response </returns>
  1236. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1237. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1238. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1239. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1240. </member>
  1241. <member name="M:Minio.ApiEndpoints.IBucketOperations.SetVersioningAsync(Minio.DataModel.Args.SetVersioningArgs,System.Threading.CancellationToken)">
  1242. <summary>
  1243. Set Versioning as specified on the bucket with given bucket name
  1244. </summary>
  1245. <param name="args">SetVersioningArgs Arguments Object with information like Bucket name, Versioning configuration</param>
  1246. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1247. <returns> Task </returns>
  1248. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1249. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1250. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1251. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1252. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1253. </member>
  1254. <member name="M:Minio.ApiEndpoints.IBucketOperations.SetBucketEncryptionAsync(Minio.DataModel.Args.SetBucketEncryptionArgs,System.Threading.CancellationToken)">
  1255. <summary>
  1256. Sets the Encryption Configuration for the bucket.
  1257. </summary>
  1258. <param name="args">SetBucketEncryptionArgs Arguments Object with information like Bucket name, encryption config</param>
  1259. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1260. <returns> Task </returns>
  1261. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1262. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1263. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1264. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1265. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1266. </member>
  1267. <member name="M:Minio.ApiEndpoints.IBucketOperations.GetBucketEncryptionAsync(Minio.DataModel.Args.GetBucketEncryptionArgs,System.Threading.CancellationToken)">
  1268. <summary>
  1269. Returns the Encryption Configuration for the bucket.
  1270. </summary>
  1271. <param name="args">GetBucketEncryptionArgs Arguments Object encapsulating information like Bucket name</param>
  1272. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1273. <returns> An object of type ServerSideEncryptionConfiguration </returns>
  1274. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1275. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1276. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1277. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1278. </member>
  1279. <member name="M:Minio.ApiEndpoints.IBucketOperations.RemoveBucketEncryptionAsync(Minio.DataModel.Args.RemoveBucketEncryptionArgs,System.Threading.CancellationToken)">
  1280. <summary>
  1281. Removes the Encryption Configuration for the bucket.
  1282. </summary>
  1283. <param name="args">RemoveBucketEncryptionArgs Arguments Object encapsulating information like Bucket name</param>
  1284. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1285. <returns> Task </returns>
  1286. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1287. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1288. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1289. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1290. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1291. </member>
  1292. <member name="M:Minio.ApiEndpoints.IBucketOperations.SetBucketLifecycleAsync(Minio.DataModel.Args.SetBucketLifecycleArgs,System.Threading.CancellationToken)">
  1293. <summary>
  1294. Sets the Lifecycle configuration for this bucket
  1295. </summary>
  1296. <param name="args">SetBucketLifecycleArgs Arguments Object with information like Bucket name, tag key-value pairs</param>
  1297. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1298. <returns></returns>
  1299. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1300. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1301. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1302. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1303. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1304. </member>
  1305. <member name="M:Minio.ApiEndpoints.IBucketOperations.GetBucketLifecycleAsync(Minio.DataModel.Args.GetBucketLifecycleArgs,System.Threading.CancellationToken)">
  1306. <summary>
  1307. Gets Lifecycle configuration set for this bucket returned in an object
  1308. </summary>
  1309. <param name="args">GetBucketLifecycleArgs Arguments Object with information like Bucket name</param>
  1310. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1311. <returns>Lifecycle Object with key-value tag pairs</returns>
  1312. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1313. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1314. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1315. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1316. </member>
  1317. <member name="M:Minio.ApiEndpoints.IBucketOperations.RemoveBucketLifecycleAsync(Minio.DataModel.Args.RemoveBucketLifecycleArgs,System.Threading.CancellationToken)">
  1318. <summary>
  1319. Removes Lifecycle configuration stored for the bucket.
  1320. </summary>
  1321. <param name="args">RemoveBucketLifecycleArgs Arguments Object with information like Bucket name</param>
  1322. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1323. <returns></returns>
  1324. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1325. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1326. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1327. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1328. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1329. </member>
  1330. <member name="M:Minio.ApiEndpoints.IBucketOperations.GetBucketReplicationAsync(Minio.DataModel.Args.GetBucketReplicationArgs,System.Threading.CancellationToken)">
  1331. <summary>
  1332. Gets Replication configuration set for this bucket
  1333. </summary>
  1334. <param name="args">GetBucketReplicationArgs Arguments Object with information like Bucket name</param>
  1335. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1336. <returns>Replication configuration object</returns>
  1337. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1338. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1339. <exception cref="T:Minio.Exceptions.MissingBucketReplicationConfigurationException">When bucket replication configuration is not set</exception>
  1340. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1341. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1342. </member>
  1343. <member name="M:Minio.ApiEndpoints.IBucketOperations.SetBucketReplicationAsync(Minio.DataModel.Args.SetBucketReplicationArgs,System.Threading.CancellationToken)">
  1344. <summary>
  1345. Sets the Replication configuration for this bucket
  1346. </summary>
  1347. <param name="args">
  1348. SetBucketReplicationArgs Arguments Object with information like Bucket name, Replication
  1349. Configuration object
  1350. </param>
  1351. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1352. <returns></returns>
  1353. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1354. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1355. <exception cref="T:Minio.Exceptions.MissingBucketReplicationConfigurationException">When bucket replication configuration is not set</exception>
  1356. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1357. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1358. </member>
  1359. <member name="M:Minio.ApiEndpoints.IBucketOperations.RemoveBucketReplicationAsync(Minio.DataModel.Args.RemoveBucketReplicationArgs,System.Threading.CancellationToken)">
  1360. <summary>
  1361. Removes Replication configuration stored for the bucket.
  1362. </summary>
  1363. <param name="args">RemoveBucketReplicationArgs Arguments Object with information like Bucket name</param>
  1364. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1365. <returns></returns>
  1366. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1367. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1368. <exception cref="T:Minio.Exceptions.MissingBucketReplicationConfigurationException">When bucket replication configuration is not set</exception>
  1369. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1370. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1371. </member>
  1372. <member name="M:Minio.ApiEndpoints.IObjectOperations.GetObjectLegalHoldAsync(Minio.DataModel.Args.GetObjectLegalHoldArgs,System.Threading.CancellationToken)">
  1373. <summary>
  1374. Get the configuration object for Legal Hold Status
  1375. </summary>
  1376. <param name="args">
  1377. GetObjectLegalHoldArgs Arguments Object which has object identifier information - bucket name,
  1378. object name, version ID
  1379. </param>
  1380. <param name="cancellationToken">Optional cancellation token to cancel the operation </param>
  1381. <returns> True if Legal Hold is ON, false otherwise </returns>
  1382. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1383. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1384. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1385. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1386. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1387. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  1388. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1389. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1390. </member>
  1391. <member name="M:Minio.ApiEndpoints.IObjectOperations.SetObjectLegalHoldAsync(Minio.DataModel.Args.SetObjectLegalHoldArgs,System.Threading.CancellationToken)">
  1392. <summary>
  1393. Set the configuration for Legal Hold Status
  1394. </summary>
  1395. <param name="args">
  1396. SetObjectLegalHoldArgs Arguments Object which has object identifier information - bucket name,
  1397. object name, version ID and the status (ON/OFF) of legal-hold
  1398. </param>
  1399. <param name="cancellationToken">Optional cancellation token to cancel the operation </param>
  1400. <returns> Task </returns>
  1401. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1402. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1403. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1404. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1405. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1406. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  1407. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1408. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1409. </member>
  1410. <member name="M:Minio.ApiEndpoints.IObjectOperations.SetObjectRetentionAsync(Minio.DataModel.Args.SetObjectRetentionArgs,System.Threading.CancellationToken)">
  1411. <summary>
  1412. Set the Retention using the configuration object
  1413. </summary>
  1414. <param name="args">
  1415. SetObjectRetentionArgs Arguments Object which has object identifier information - bucket name,
  1416. object name, version ID
  1417. </param>
  1418. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1419. <returns> Task </returns>
  1420. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1421. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1422. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1423. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1424. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1425. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  1426. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1427. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1428. </member>
  1429. <member name="M:Minio.ApiEndpoints.IObjectOperations.GetObjectRetentionAsync(Minio.DataModel.Args.GetObjectRetentionArgs,System.Threading.CancellationToken)">
  1430. <summary>
  1431. Get the Retention configuration for the object
  1432. </summary>
  1433. <param name="args">
  1434. GetObjectRetentionArgs Arguments Object which has object identifier information - bucket name,
  1435. object name, version ID
  1436. </param>
  1437. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1438. <returns> ObjectRetentionConfiguration object which contains the Retention configuration </returns>
  1439. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1440. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1441. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1442. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1443. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1444. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1445. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  1446. </member>
  1447. <member name="M:Minio.ApiEndpoints.IObjectOperations.ClearObjectRetentionAsync(Minio.DataModel.Args.ClearObjectRetentionArgs,System.Threading.CancellationToken)">
  1448. <summary>
  1449. Clears the Retention configuration for the object
  1450. </summary>
  1451. <param name="args">
  1452. ClearObjectRetentionArgs Arguments Object which has object identifier information - bucket name,
  1453. object name, version ID
  1454. </param>
  1455. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1456. <returns> Task </returns>
  1457. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1458. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1459. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1460. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1461. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1462. <exception cref="T:Minio.Exceptions.MissingObjectLockConfigurationException">When object lock configuration on bucket is not set</exception>
  1463. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1464. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1465. </member>
  1466. <member name="M:Minio.ApiEndpoints.IObjectOperations.RemoveObjectAsync(Minio.DataModel.Args.RemoveObjectArgs,System.Threading.CancellationToken)">
  1467. <summary>
  1468. Removes an object with given name in specific bucket
  1469. </summary>
  1470. <param name="args">
  1471. RemoveObjectArgs Arguments Object encapsulates information like - bucket name, object name, whether
  1472. delete all versions
  1473. </param>
  1474. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1475. <returns></returns>
  1476. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1477. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1478. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1479. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1480. </member>
  1481. <member name="M:Minio.ApiEndpoints.IObjectOperations.RemoveObjectsAsync(Minio.DataModel.Args.RemoveObjectsArgs,System.Threading.CancellationToken)">
  1482. <summary>
  1483. Removes list of objects from bucket
  1484. </summary>
  1485. <param name="args">
  1486. RemoveObjectsArgs Arguments Object encapsulates information like - bucket name, List of objects,
  1487. optional list of versions (for each object) to be deleted
  1488. </param>
  1489. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1490. <returns>Observable that returns delete error while deleting objects if any</returns>
  1491. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1492. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1493. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1494. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1495. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1496. </member>
  1497. <member name="M:Minio.ApiEndpoints.IObjectOperations.CopyObjectAsync(Minio.DataModel.Args.CopyObjectArgs,System.Threading.CancellationToken)">
  1498. <summary>
  1499. Copy a source object into a new destination object.
  1500. </summary>
  1501. <param name="args">
  1502. CopyObjectArgs Arguments Object which encapsulates bucket name, object name, destination bucket,
  1503. destination object names, Copy conditions object, metadata, SSE source, destination objects
  1504. </param>
  1505. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1506. <returns></returns>
  1507. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1508. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1509. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1510. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1511. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1512. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted copy operation, Access is denied if the key is wrong</exception>
  1513. </member>
  1514. <member name="M:Minio.ApiEndpoints.IObjectOperations.GetObjectAsync(Minio.DataModel.Args.GetObjectArgs,System.Threading.CancellationToken)">
  1515. <summary>
  1516. Get an object. The object will be streamed to the callback given by the user.
  1517. </summary>
  1518. <param name="args">
  1519. GetObjectArgs Arguments Object encapsulates information like - bucket name, object name, server-side
  1520. encryption object, action stream, length, offset
  1521. </param>
  1522. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1523. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1524. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1525. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1526. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1527. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1528. <exception cref="T:System.IO.DirectoryNotFoundException">If the directory to copy to is not found</exception>
  1529. </member>
  1530. <member name="M:Minio.ApiEndpoints.IObjectOperations.PutObjectAsync(Minio.DataModel.Args.PutObjectArgs,System.Threading.CancellationToken)">
  1531. <summary>
  1532. Creates object in a bucket fom input stream or filename.
  1533. </summary>
  1534. <param name="args">
  1535. PutObjectArgs Arguments object encapsulating bucket name, object name, file name, object data
  1536. stream, object size, content type.
  1537. </param>
  1538. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1539. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1540. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1541. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1542. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1543. <exception cref="T:System.IO.FileNotFoundException">If the file to copy from not found</exception>
  1544. <exception cref="T:System.ObjectDisposedException">The file stream has been disposed</exception>
  1545. <exception cref="T:System.NotSupportedException">The file stream cannot be read from</exception>
  1546. <exception cref="T:System.InvalidOperationException">The file stream is currently in a read operation</exception>
  1547. <exception cref="T:Minio.Exceptions.AccessDeniedException">For encrypted PUT operation, Access is denied if the key is wrong</exception>
  1548. </member>
  1549. <member name="M:Minio.ApiEndpoints.IObjectOperations.SelectObjectContentAsync(Minio.DataModel.Args.SelectObjectContentArgs,System.Threading.CancellationToken)">
  1550. <summary>
  1551. Select an object's content. The object will be streamed to the callback given by the user.
  1552. </summary>
  1553. <param name="args">
  1554. SelectObjectContentArgs Arguments Object which encapsulates bucket name, object name, Select Object
  1555. Options
  1556. </param>
  1557. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1558. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1559. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1560. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1561. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1562. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1563. </member>
  1564. <member name="M:Minio.ApiEndpoints.IObjectOperations.ListIncompleteUploads(Minio.DataModel.Args.ListIncompleteUploadsArgs,System.Threading.CancellationToken)">
  1565. <summary>
  1566. Lists all incomplete uploads in a given bucket and prefix recursively
  1567. </summary>
  1568. <param name="args">ListIncompleteUploadsArgs Arguments Object which encapsulates bucket name, prefix, recursive</param>
  1569. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1570. <returns>A lazily populated list of incomplete uploads</returns>
  1571. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key provided is invalid</exception>
  1572. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1573. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1574. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1575. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1576. </member>
  1577. <member name="M:Minio.ApiEndpoints.IObjectOperations.RemoveIncompleteUploadAsync(Minio.DataModel.Args.RemoveIncompleteUploadArgs,System.Threading.CancellationToken)">
  1578. <summary>
  1579. Remove incomplete uploads from a given bucket and objectName
  1580. </summary>
  1581. <param name="args">RemoveIncompleteUploadArgs Arguments Object which encapsulates bucket, object names</param>
  1582. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1583. <returns></returns>
  1584. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1585. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1586. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1587. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1588. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1589. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1590. </member>
  1591. <member name="M:Minio.ApiEndpoints.IObjectOperations.PresignedGetObjectAsync(Minio.DataModel.Args.PresignedGetObjectArgs)">
  1592. <summary>
  1593. Presigned get url - returns a presigned url to access an object's data without credentials.URL can have a maximum
  1594. expiry of
  1595. up to 7 days or a minimum of 1 second.Additionally, you can override a set of response headers using reqParams.
  1596. </summary>
  1597. <param name="args">
  1598. PresignedGetObjectArgs Arguments object encapsulating bucket and object names, expiry time, response
  1599. headers, request date
  1600. </param>
  1601. <returns></returns>
  1602. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1603. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1604. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1605. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1606. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1607. </member>
  1608. <member name="M:Minio.ApiEndpoints.IObjectOperations.PresignedPostPolicyAsync(Minio.DataModel.Args.PresignedPostPolicyArgs)">
  1609. <summary>
  1610. Presigned post policy
  1611. </summary>
  1612. <param name="args">PresignedPostPolicyArgs Arguments object encapsulating Policy, Expiry, Region, </param>
  1613. <returns>Tuple of URI and Policy Form data</returns>
  1614. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1615. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1616. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1617. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1618. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1619. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1620. </member>
  1621. <member name="M:Minio.ApiEndpoints.IObjectOperations.PresignedPutObjectAsync(Minio.DataModel.Args.PresignedPutObjectArgs)">
  1622. <summary>
  1623. Presigned Put url -returns a presigned url to upload an object without credentials.URL can have a maximum expiry of
  1624. upto 7 days or a minimum of 1 second.
  1625. </summary>
  1626. <param name="args">PresignedPutObjectArgs Arguments Object which encapsulates bucket, object names, expiry</param>
  1627. <returns></returns>
  1628. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1629. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1630. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1631. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1632. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1633. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1634. </member>
  1635. <member name="M:Minio.ApiEndpoints.IObjectOperations.StatObjectAsync(Minio.DataModel.Args.StatObjectArgs,System.Threading.CancellationToken)">
  1636. <summary>
  1637. Tests the object's existence and returns metadata about existing objects.
  1638. </summary>
  1639. <param name="args">
  1640. StatObjectArgs Arguments Object encapsulates information like - bucket name, object name,
  1641. server-side encryption object
  1642. </param>
  1643. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1644. <returns>Facts about the object</returns>
  1645. </member>
  1646. <member name="M:Minio.ApiEndpoints.IObjectOperations.PresignedPostPolicyAsync(Minio.DataModel.PostPolicy)">
  1647. <summary>
  1648. Presigned post policy
  1649. </summary>
  1650. <param name="policy"></param>
  1651. <returns></returns>
  1652. </member>
  1653. <member name="M:Minio.ApiEndpoints.IObjectOperations.GetObjectTagsAsync(Minio.DataModel.Args.GetObjectTagsArgs,System.Threading.CancellationToken)">
  1654. <summary>
  1655. Gets Tagging values set for this object
  1656. </summary>
  1657. <param name="args"> GetObjectTagsArgs Arguments Object with information like Bucket, Object name, (optional)version Id</param>
  1658. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1659. <returns>Tagging Object with key-value tag pairs</returns>
  1660. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1661. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1662. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1663. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1664. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1665. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1666. </member>
  1667. <member name="M:Minio.ApiEndpoints.IObjectOperations.SetObjectTagsAsync(Minio.DataModel.Args.SetObjectTagsArgs,System.Threading.CancellationToken)">
  1668. <summary>
  1669. Sets the Tagging values for this object
  1670. </summary>
  1671. <param name="args">
  1672. SetObjectTagsArgs Arguments Object with information like Bucket name,Object name, (optional)version
  1673. Id, tag key-value pairs
  1674. </param>
  1675. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1676. <returns></returns>
  1677. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1678. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1679. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1680. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1681. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1682. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1683. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1684. </member>
  1685. <member name="M:Minio.ApiEndpoints.IObjectOperations.RemoveObjectTagsAsync(Minio.DataModel.Args.RemoveObjectTagsArgs,System.Threading.CancellationToken)">
  1686. <summary>
  1687. Removes Tagging values stored for the object
  1688. </summary>
  1689. <param name="args">RemoveObjectTagsArgs Arguments Object with information like Bucket name</param>
  1690. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  1691. <returns></returns>
  1692. <exception cref="T:Minio.Exceptions.AuthorizationException">When access or secret key is invalid</exception>
  1693. <exception cref="T:Minio.Exceptions.InvalidBucketNameException">When bucket name is invalid</exception>
  1694. <exception cref="T:Minio.Exceptions.InvalidObjectNameException">When object name is invalid</exception>
  1695. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucket is not found</exception>
  1696. <exception cref="T:System.NotImplementedException">When a functionality or extension is not implemented</exception>
  1697. <exception cref="T:Minio.Exceptions.ObjectNotFoundException">When object is not found</exception>
  1698. <exception cref="T:Minio.Exceptions.MalFormedXMLException">When configuration XML provided is invalid</exception>
  1699. </member>
  1700. <member name="T:Minio.AWSS3Endpoints">
  1701. <summary>
  1702. Amazon AWS S3 endpoints for various regions.
  1703. </summary>
  1704. </member>
  1705. <member name="M:Minio.AWSS3Endpoints.Endpoint(System.String)">
  1706. <summary>
  1707. Gets Amazon S3 endpoint for the relevant region.
  1708. </summary>
  1709. <param name="region"></param>
  1710. <returns></returns>
  1711. </member>
  1712. <member name="T:Minio.BucketRegionCache">
  1713. <summary>
  1714. A singleton bucket/region cache map.
  1715. </summary>
  1716. </member>
  1717. <member name="M:Minio.BucketRegionCache.Region(System.String)">
  1718. <summary>
  1719. Returns AWS region for given bucket name.
  1720. </summary>
  1721. <param name="bucketName"></param>
  1722. <returns></returns>
  1723. </member>
  1724. <member name="M:Minio.BucketRegionCache.Add(System.String,System.String)">
  1725. <summary>
  1726. Adds bucket name and its region to BucketRegionCache.
  1727. </summary>
  1728. <param name="bucketName"></param>
  1729. <param name="region"></param>
  1730. </member>
  1731. <member name="M:Minio.BucketRegionCache.Remove(System.String)">
  1732. <summary>
  1733. Removes region cache of the bucket if any.
  1734. </summary>
  1735. <param name="bucketName"></param>
  1736. </member>
  1737. <member name="M:Minio.BucketRegionCache.Exists(System.String)">
  1738. <summary>
  1739. Returns true if given bucket name is in the map else false.
  1740. </summary>
  1741. <param name="bucketName"></param>
  1742. <returns></returns>
  1743. </member>
  1744. <member name="M:Minio.BucketRegionCache.Update(Minio.IMinioClient,System.String)">
  1745. <summary>
  1746. Updates Region cache for given bucket.
  1747. </summary>
  1748. <param name="client"></param>
  1749. <param name="bucketName"></param>
  1750. </member>
  1751. <member name="T:Minio.DataModel.CopyConditions">
  1752. <summary>
  1753. A container class to hold all the Conditions to be checked before copying an object.
  1754. </summary>
  1755. </member>
  1756. <member name="P:Minio.DataModel.CopyConditions.ByteRange">
  1757. <summary>
  1758. Get range size
  1759. </summary>
  1760. <returns></returns>
  1761. </member>
  1762. <member name="P:Minio.DataModel.CopyConditions.Conditions">
  1763. <summary>
  1764. Get all the set copy conditions map.
  1765. </summary>
  1766. <returns></returns>
  1767. </member>
  1768. <member name="M:Minio.DataModel.CopyConditions.Clone">
  1769. <summary>
  1770. Clone CopyConditions object
  1771. </summary>
  1772. <returns>new CopyConditions object</returns>
  1773. </member>
  1774. <member name="M:Minio.DataModel.CopyConditions.SetModified(System.DateTime)">
  1775. <summary>
  1776. Set modified condition, copy object modified since given time.
  1777. </summary>
  1778. <param name="date"></param>
  1779. <exception cref="T:System.ArgumentException">When date is null</exception>
  1780. </member>
  1781. <member name="M:Minio.DataModel.CopyConditions.SetUnmodified(System.DateTime)">
  1782. <summary>
  1783. Unset modified condition, copy object modified since given time.
  1784. </summary>
  1785. <param name="date"></param>
  1786. <exception cref="T:System.ArgumentException">When date is null</exception>
  1787. </member>
  1788. <member name="M:Minio.DataModel.CopyConditions.SetMatchETag(System.String)">
  1789. <summary>
  1790. Set matching ETag condition, copy object which matches
  1791. the following ETag.
  1792. </summary>
  1793. <param name="etag"></param>
  1794. <exception cref="T:System.ArgumentException">When etag is null</exception>
  1795. </member>
  1796. <member name="M:Minio.DataModel.CopyConditions.SetMatchETagNone(System.String)">
  1797. <summary>
  1798. Set matching ETag none condition, copy object which does not
  1799. match the following ETag.
  1800. </summary>
  1801. <param name="etag"></param>
  1802. <exception cref="T:System.ArgumentException">When etag is null</exception>
  1803. </member>
  1804. <member name="M:Minio.DataModel.CopyConditions.SetReplaceMetadataDirective">
  1805. <summary>
  1806. Set replace metadata directive which specifies that server side copy needs to replace metadata
  1807. on destination with custom metadata provided in the request.
  1808. </summary>
  1809. </member>
  1810. <member name="M:Minio.DataModel.CopyConditions.HasReplaceMetadataDirective">
  1811. <summary>
  1812. Return true if replace metadata directive is specified
  1813. </summary>
  1814. <returns></returns>
  1815. </member>
  1816. <member name="M:Minio.DataModel.CopyConditions.SetByteRange(System.Int64,System.Int64)">
  1817. <summary>
  1818. Set Byte Range condition, copy object which falls within the
  1819. start and end byte range specified by user
  1820. </summary>
  1821. <param name="firstByte"></param>
  1822. <param name="lastByte"></param>
  1823. <exception cref="T:System.ArgumentException">When firstByte is null or lastByte is null</exception>
  1824. </member>
  1825. <member name="T:Minio.DataModel.Encryption.IServerSideEncryption">
  1826. <summary>
  1827. ServerSideEncryption interface
  1828. </summary>
  1829. </member>
  1830. <member name="T:Minio.DataModel.Encryption.SSEC">
  1831. <summary>
  1832. Server-side encryption with customer provided keys (SSE-C)
  1833. </summary>
  1834. </member>
  1835. <member name="T:Minio.DataModel.Encryption.SSECopy">
  1836. <summary>
  1837. Server-side encryption option for source side SSE-C copy operation
  1838. </summary>
  1839. </member>
  1840. <member name="T:Minio.DataModel.Encryption.SSEKMS">
  1841. <summary>
  1842. Server-side encryption with AWS KMS managed keys
  1843. </summary>
  1844. </member>
  1845. <member name="M:Minio.DataModel.Encryption.SSEKMS.MarshalContext">
  1846. <summary>
  1847. Serialize context into JSON string.
  1848. </summary>
  1849. <returns>Serialized JSON context</returns>
  1850. </member>
  1851. <member name="T:Minio.DataModel.Encryption.SSES3">
  1852. <summary>
  1853. Server-side encryption with S3 managed encryption keys (SSE-S3)
  1854. </summary>
  1855. </member>
  1856. <member name="T:Minio.DataModel.Notification.Arn">
  1857. <summary>
  1858. Arn holds ARN information that will be sent to the web service,
  1859. ARN desciption can be found in http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
  1860. </summary>
  1861. </member>
  1862. <member name="M:Minio.DataModel.Notification.Arn.#ctor(System.String)">
  1863. <summary>
  1864. Pass valid Arn string on aws to constructor
  1865. </summary>
  1866. <param name="arnString"></param>
  1867. </member>
  1868. <member name="M:Minio.DataModel.Notification.Arn.#ctor(System.String,System.String,System.String,System.String,System.String)">
  1869. <summary>
  1870. Constructs new ARN based on the given partition, service, region, account id and resource
  1871. </summary>
  1872. <param name="partition"></param>
  1873. <param name="service"></param>
  1874. <param name="region"></param>
  1875. <param name="accountId"></param>
  1876. <param name="resource"></param>
  1877. </member>
  1878. <member name="T:Minio.DataModel.Notification.BucketNotification">
  1879. <summary>
  1880. Helper class to parse NotificationConfiguration from AWS S3 response XML.
  1881. </summary>
  1882. </member>
  1883. <member name="M:Minio.DataModel.Notification.BucketNotification.AddTopic(Minio.DataModel.Notification.TopicConfig)">
  1884. <summary>
  1885. AddTopic adds a given topic config to the general bucket notification config
  1886. </summary>
  1887. <param name="topicConfig"></param>
  1888. </member>
  1889. <member name="M:Minio.DataModel.Notification.BucketNotification.AddQueue(Minio.DataModel.Notification.QueueConfig)">
  1890. <summary>
  1891. AddQueue adds a given queue config to the general bucket notification config
  1892. </summary>
  1893. <param name="queueConfig"></param>
  1894. </member>
  1895. <member name="M:Minio.DataModel.Notification.BucketNotification.AddLambda(Minio.DataModel.Notification.LambdaConfig)">
  1896. <summary>
  1897. AddLambda adds a given lambda config to the general bucket notification config
  1898. </summary>
  1899. <param name="lambdaConfig"></param>
  1900. </member>
  1901. <member name="M:Minio.DataModel.Notification.BucketNotification.RemoveTopicByArn(Minio.DataModel.Notification.Arn)">
  1902. <summary>
  1903. RemoveTopicByArn removes all topic configurations that match the exact specified ARN
  1904. </summary>
  1905. <param name="topicArn"></param>
  1906. </member>
  1907. <member name="M:Minio.DataModel.Notification.BucketNotification.RemoveQueueByArn(Minio.DataModel.Notification.Arn)">
  1908. <summary>
  1909. RemoveQueueByArn removes all queue configurations that match the exact specified ARN
  1910. </summary>
  1911. <param name="queueArn"></param>
  1912. </member>
  1913. <member name="M:Minio.DataModel.Notification.BucketNotification.RemoveLambdaByArn(Minio.DataModel.Notification.Arn)">
  1914. <summary>
  1915. RemoveLambdaByArn removes all lambda configurations that match the exact specified ARN
  1916. </summary>
  1917. <param name="lambdaArn"></param>
  1918. </member>
  1919. <member name="M:Minio.DataModel.Notification.BucketNotification.ShouldSerializeLambdaConfigs">
  1920. <summary>
  1921. Helper methods to guide XMLSerializer
  1922. </summary>
  1923. <returns></returns>
  1924. </member>
  1925. <member name="M:Minio.DataModel.Notification.BucketNotification.ToXML">
  1926. <summary>
  1927. Serializes the notification configuration as an XML string
  1928. </summary>
  1929. <returns></returns>
  1930. </member>
  1931. <member name="T:Minio.DataModel.Notification.EventType">
  1932. <summary>
  1933. EventType is a S3 notification event associated to the bucket notification configuration
  1934. </summary>
  1935. </member>
  1936. <member name="T:Minio.DataModel.Notification.FilterRule">
  1937. <summary>
  1938. FilterRule - child of S3Key, a tag in the notification xml which
  1939. carries suffix/prefix filters
  1940. </summary>
  1941. </member>
  1942. <member name="T:Minio.DataModel.Notification.LambdaConfig">
  1943. <summary>
  1944. LambdaConfig carries one single cloudfunction notification configuration
  1945. </summary>
  1946. </member>
  1947. <member name="T:Minio.DataModel.Notification.MinioNotification">
  1948. <summary>
  1949. Helper class to deserialize notifications generated
  1950. from MinioNotificaitonRaw by ListenBucketNotifications
  1951. </summary>
  1952. </member>
  1953. <member name="T:Minio.DataModel.Notification.MinioNotificationRaw">
  1954. <summary>
  1955. Stores raw json events generated by ListenBucketNotifications
  1956. The Minio client doesn't depend on a JSON library so we can let
  1957. the caller use a library of their choice
  1958. </summary>
  1959. </member>
  1960. <member name="T:Minio.DataModel.Notification.NotificationConfiguration">
  1961. <summary>
  1962. NotificationConfig - represents one single notification configuration
  1963. such as topic, queue or lambda configuration
  1964. </summary>
  1965. </member>
  1966. <member name="M:Minio.DataModel.Notification.NotificationConfiguration.AddFilterSuffix(System.String)">
  1967. <summary>
  1968. AddFilterSuffix sets the suffix configuration to the current notification config
  1969. </summary>
  1970. <param name="suffix"></param>
  1971. </member>
  1972. <member name="M:Minio.DataModel.Notification.NotificationConfiguration.AddFilterPrefix(System.String)">
  1973. <summary>
  1974. AddFilterPrefix sets the prefix configuration to the current notification config
  1975. </summary>
  1976. <param name="prefix"></param>
  1977. </member>
  1978. <member name="T:Minio.DataModel.Notification.QueueConfig">
  1979. <summary>
  1980. QueueConfig carries one single queue notification configuration
  1981. </summary>
  1982. </member>
  1983. <member name="T:Minio.DataModel.Notification.S3Key">
  1984. <summary>
  1985. S3Key - child of Filter, a tag in the notification xml which carries suffix/prefix
  1986. filters and allows filtering event notifications based on S3 Object key's name
  1987. </summary>
  1988. </member>
  1989. <member name="T:Minio.DataModel.Notification.TopicConfig">
  1990. <summary>
  1991. TopicConfig carries one single topic notification configuration
  1992. </summary>
  1993. </member>
  1994. <member name="M:Minio.DataModel.Notification.TopicConfig.Equals(System.Object)">
  1995. <summary>
  1996. Implement equality for this object
  1997. </summary>
  1998. <param name="obj"></param>
  1999. <returns></returns>
  2000. </member>
  2001. <member name="P:Minio.DataModel.PostPolicy.FormData">
  2002. <summary>
  2003. Get the populated dictionary of policy data.
  2004. </summary>
  2005. <returns>Dictionary of policy data</returns>
  2006. </member>
  2007. <member name="M:Minio.DataModel.PostPolicy.SetExpires(System.DateTime)">
  2008. <summary>
  2009. Set expiration policy.
  2010. </summary>
  2011. <param name="expiration">Expiration time for the policy</param>
  2012. </member>
  2013. <member name="M:Minio.DataModel.PostPolicy.SetKey(System.String)">
  2014. <summary>
  2015. Set key policy.
  2016. </summary>
  2017. <param name="key">Object name for the policy</param>
  2018. </member>
  2019. <member name="M:Minio.DataModel.PostPolicy.SetKeyStartsWith(System.String)">
  2020. <summary>
  2021. Set key prefix policy.
  2022. </summary>
  2023. <param name="keyStartsWith">Object name prefix for the policy</param>
  2024. </member>
  2025. <member name="M:Minio.DataModel.PostPolicy.SetBucket(System.String)">
  2026. <summary>
  2027. Set bucket policy.
  2028. </summary>
  2029. <param name="bucket">Bucket name for the policy</param>
  2030. </member>
  2031. <member name="M:Minio.DataModel.PostPolicy.SetCacheControl(System.String)">
  2032. <summary>
  2033. Set cache control
  2034. </summary>
  2035. <param name="cacheControl">CacheControl for the policy</param>
  2036. </member>
  2037. <member name="M:Minio.DataModel.PostPolicy.SetContentType(System.String)">
  2038. <summary>
  2039. Set content type policy.
  2040. </summary>
  2041. <param name="contentType">ContentType for the policy</param>
  2042. </member>
  2043. <member name="M:Minio.DataModel.PostPolicy.SetContentEncoding(System.String)">
  2044. <summary>
  2045. Set content encoding
  2046. </summary>
  2047. <param name="contentEncoding">ContentEncoding for the policy</param>
  2048. </member>
  2049. <member name="M:Minio.DataModel.PostPolicy.SetContentLength(System.Int64)">
  2050. <summary>
  2051. Set content length
  2052. </summary>
  2053. <param name="contentLength">ContentLength for the policy</param>
  2054. </member>
  2055. <member name="M:Minio.DataModel.PostPolicy.SetContentRange(System.Int64,System.Int64)">
  2056. <summary>
  2057. Set content range
  2058. </summary>
  2059. <param name="startRange">ContentRange for the policy</param>
  2060. <param name="endRange"></param>
  2061. </member>
  2062. <member name="M:Minio.DataModel.PostPolicy.SetSessionToken(System.String)">
  2063. <summary>
  2064. Set session token
  2065. </summary>
  2066. <param name="sessionToken">set session token</param>
  2067. </member>
  2068. <member name="M:Minio.DataModel.PostPolicy.SetSuccessStatusAction(System.String)">
  2069. <summary>
  2070. Set the success action status of the object for this policy based upload.
  2071. </summary>
  2072. <param name="status">Success action status</param>
  2073. </member>
  2074. <member name="M:Minio.DataModel.PostPolicy.SetUserMetadata(System.String,System.String)">
  2075. <summary>
  2076. Set user specified metadata as a key/value couple.
  2077. </summary>
  2078. <param name="key">Key and Value to insert in the metadata</param>
  2079. <param name="value"></param>
  2080. </member>
  2081. <member name="M:Minio.DataModel.PostPolicy.SetAlgorithm(System.String)">
  2082. <summary>
  2083. Set signature algorithm policy.
  2084. </summary>
  2085. <param name="algorithm">Set signature algorithm used for the policy</param>
  2086. </member>
  2087. <member name="M:Minio.DataModel.PostPolicy.SetCredential(System.String)">
  2088. <summary>
  2089. Set credential policy.
  2090. </summary>
  2091. <param name="credential">Set credential string for the policy</param>
  2092. </member>
  2093. <member name="M:Minio.DataModel.PostPolicy.SetDate(System.DateTime)">
  2094. <summary>
  2095. Set date policy.
  2096. </summary>
  2097. <param name="date">Set date for the policy</param>
  2098. </member>
  2099. <member name="M:Minio.DataModel.PostPolicy.MarshalJSON">
  2100. <summary>
  2101. Serialize policy into JSON string.
  2102. </summary>
  2103. <returns>Serialized JSON policy</returns>
  2104. </member>
  2105. <member name="M:Minio.DataModel.PostPolicy.Base64">
  2106. <summary>
  2107. Compute base64 encoded form of JSON policy.
  2108. </summary>
  2109. <returns>Base64 encoded string of JSON policy</returns>
  2110. </member>
  2111. <member name="M:Minio.DataModel.PostPolicy.IsBucketSet">
  2112. <summary>
  2113. Verify if bucket is set in policy.
  2114. </summary>
  2115. <returns>true if bucket is set</returns>
  2116. </member>
  2117. <member name="M:Minio.DataModel.PostPolicy.IsKeySet">
  2118. <summary>
  2119. Verify if key is set in policy.
  2120. </summary>
  2121. <returns>true if key is set</returns>
  2122. </member>
  2123. <member name="M:Minio.DataModel.PostPolicy.IsExpirationSet">
  2124. <summary>
  2125. Verify if expiration is set in policy.
  2126. </summary>
  2127. <returns>true if expiration is set</returns>
  2128. </member>
  2129. <member name="F:Minio.Helper.Constants.MaxParts">
  2130. <summary>
  2131. Maximum number of parts
  2132. </summary>
  2133. </member>
  2134. <member name="F:Minio.Helper.Constants.MinimumPartSize">
  2135. <summary>
  2136. Minimum part size
  2137. </summary>
  2138. </member>
  2139. <member name="F:Minio.Helper.Constants.MinimumPUTPartSize">
  2140. <summary>
  2141. Minimum PUT part size
  2142. </summary>
  2143. </member>
  2144. <member name="F:Minio.Helper.Constants.MinimumCOPYPartSize">
  2145. <summary>
  2146. Minimum COPY part size
  2147. </summary>
  2148. </member>
  2149. <member name="F:Minio.Helper.Constants.MaximumPartSize">
  2150. <summary>
  2151. Maximum part size
  2152. </summary>
  2153. </member>
  2154. <member name="F:Minio.Helper.Constants.MaximumStreamObjectSize">
  2155. <summary>
  2156. Maximum streaming object size
  2157. </summary>
  2158. </member>
  2159. <member name="F:Minio.Helper.Constants.MaxSinglePutObjectSize">
  2160. <summary>
  2161. maxSinglePutObjectSize - maximum size 5GiB of object per PUT operation
  2162. </summary>
  2163. </member>
  2164. <member name="F:Minio.Helper.Constants.MaxSingleCopyObjectSize">
  2165. <summary>
  2166. maxSingleCopyObjectSize - 5GiB
  2167. </summary>
  2168. </member>
  2169. <member name="F:Minio.Helper.Constants.MaxMultipartPutObjectSize">
  2170. <summary>
  2171. maxMultipartPutObjectSize - maximum size 5TiB of object for Multipart operation
  2172. </summary>
  2173. </member>
  2174. <member name="F:Minio.Helper.Constants.OptimalReadBufferSize">
  2175. <summary>
  2176. OptimalReadBufferSize - optimal buffer 5MiB used for reading through Read operation
  2177. </summary>
  2178. </member>
  2179. <member name="F:Minio.Helper.Constants.SSEGenericHeader">
  2180. <summary>
  2181. SSEGenericHeader is the AWS SSE header used for SSE-S3 and SSE-KMS.
  2182. </summary>
  2183. </member>
  2184. <member name="F:Minio.Helper.Constants.SSEKMSKeyId">
  2185. <summary>
  2186. SSEKMSKeyId is the AWS SSE KMS Key-Id
  2187. </summary>
  2188. </member>
  2189. <member name="F:Minio.Helper.Constants.SSEKMSContext">
  2190. <summary>
  2191. SSEKMSContext is the AWS SSE KMS Context.
  2192. </summary>
  2193. </member>
  2194. <member name="M:Minio.Helper.RegionHelper.GetRegionFromEndpoint(System.String)">
  2195. <summary>
  2196. Get corresponding region for input host.
  2197. </summary>
  2198. <param name="endpoint">S3 API endpoint</param>
  2199. <returns>Region corresponding to the endpoint. Default is 'us-east-1'</returns>
  2200. </member>
  2201. <member name="M:Minio.Helper.RequestUtil.ValidateEndpoint(System.Uri,System.String)">
  2202. <summary>
  2203. Validates URI to check if it is well formed. Otherwise cry foul.
  2204. </summary>
  2205. </member>
  2206. <member name="M:Minio.Helper.RequestUtil.IsValidEndpoint(System.String)">
  2207. <summary>
  2208. Validate Url endpoint
  2209. </summary>
  2210. <param name="endpoint"></param>
  2211. <returns>true/false</returns>
  2212. </member>
  2213. <member name="M:Minio.Helper.S3utils.IsValidIP(System.String)">
  2214. <summary>
  2215. IsValidIP parses input string for ip address validity.
  2216. </summary>
  2217. <param name="ip"></param>
  2218. <returns></returns>
  2219. </member>
  2220. <member name="M:Minio.Helper.Utils.ValidateBucketName(System.String)">
  2221. <summary>
  2222. IsValidBucketName - verify bucket name in accordance with
  2223. http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html
  2224. </summary>
  2225. <param name="bucketName">Bucket to test existence of</param>
  2226. </member>
  2227. <member name="M:Minio.Helper.Utils.CalculateMultiPartSize(System.Int64,System.Boolean)">
  2228. <summary>
  2229. Calculate part size and number of parts required.
  2230. </summary>
  2231. <param name="size"></param>
  2232. <param name="copy"> If true, use COPY part size, else use PUT part size</param>
  2233. <returns></returns>
  2234. </member>
  2235. <member name="M:Minio.Helper.Utils.IsValidExpiry(System.Int32)">
  2236. <summary>
  2237. Check if input expires value is valid.
  2238. </summary>
  2239. <param name="expiryInt">time to expiry in seconds</param>
  2240. <returns>bool</returns>
  2241. </member>
  2242. <member name="M:Minio.LoggingExtensions.LogRequest(Minio.IMinioClient,System.Net.Http.HttpRequestMessage,Minio.DataModel.Result.ResponseResult,System.Double)">
  2243. <summary>
  2244. Logs the request sent to server and corresponding response
  2245. </summary>
  2246. <param name="minioClient"></param>
  2247. <param name="request"></param>
  2248. <param name="response"></param>
  2249. <param name="durationMs"></param>
  2250. </member>
  2251. <member name="M:Minio.MinioClientExtensions.WithSSL(Minio.IMinioClient,System.Boolean)">
  2252. <summary>
  2253. Connects to Cloud Storage with HTTPS if this method is invoked on client object
  2254. </summary>
  2255. <returns></returns>
  2256. </member>
  2257. <member name="M:Minio.MinioClientExtensions.WithProxy(Minio.IMinioClient,System.Net.IWebProxy)">
  2258. <summary>
  2259. Uses webproxy for all requests if this method is invoked on client object.
  2260. </summary>
  2261. <param name="minioClient">The MinioClient instance used</param>
  2262. <param name="proxy">Information on the proxy server in the setup.</param>
  2263. <returns></returns>
  2264. </member>
  2265. <member name="M:Minio.MinioClientExtensions.WithTimeout(Minio.IMinioClient,System.Int32)">
  2266. <summary>
  2267. Uses the set timeout for all requests if this method is invoked on client object
  2268. </summary>
  2269. <param name="minioClient">The MinioClient instance used</param>
  2270. <param name="timeout">Timeout in milliseconds.</param>
  2271. <returns></returns>
  2272. </member>
  2273. <member name="M:Minio.MinioClientExtensions.WithRetryPolicy(Minio.IMinioClient,Minio.Handlers.IRetryPolicyHandler)">
  2274. <summary>
  2275. Allows to add retry policy handler
  2276. </summary>
  2277. <param name="minioClient">The MinioClient instance used</param>
  2278. <param name="retryPolicyHandler">Delegate that will wrap execution of http client requests.</param>
  2279. <returns></returns>
  2280. </member>
  2281. <member name="M:Minio.MinioClientExtensions.WithRetryPolicy(Minio.IMinioClient,System.Func{System.Func{System.Threading.Tasks.Task{Minio.DataModel.Result.ResponseResult}},System.Threading.Tasks.Task{Minio.DataModel.Result.ResponseResult}})">
  2282. <summary>
  2283. Allows to add retry policy handler
  2284. </summary>
  2285. <param name="minioClient">The MinioClient instance used</param>
  2286. <param name="retryPolicyHandler">Delegate that will wrap execution of http client requests.</param>
  2287. <returns></returns>
  2288. </member>
  2289. <member name="M:Minio.MinioClientExtensions.WithHttpClient(Minio.IMinioClient,System.Net.Http.HttpClient,System.Boolean)">
  2290. <summary>
  2291. Allows end user to define the Http server and pass it as a parameter
  2292. </summary>
  2293. <param name="minioClient">The MinioClient instance used</param>
  2294. <param name="httpClient"> Instance of HttpClient</param>
  2295. <param name="disposeHttpClient"> Dispose the HttpClient when leaving</param>
  2296. <returns></returns>
  2297. </member>
  2298. <member name="M:Minio.MinioClientExtensions.WithCredentialsProvider(Minio.IMinioClient,Minio.Credentials.IClientProvider)">
  2299. <summary>
  2300. With provider for credentials and session token if being used
  2301. </summary>
  2302. <returns></returns>
  2303. </member>
  2304. <member name="M:Minio.MinioClientExtensions.SetAppInfo(Minio.IMinioClient,System.String,System.String)">
  2305. <summary>
  2306. Sets app version and name. Used for constructing User-Agent header in all HTTP requests
  2307. </summary>
  2308. <param name="minioClient"></param>
  2309. <param name="appName"></param>
  2310. <param name="appVersion"></param>
  2311. </member>
  2312. <member name="P:Minio.MinioConfig.FullUserAgent">
  2313. <summary>
  2314. Returns the User-Agent header for the request
  2315. </summary>
  2316. </member>
  2317. <member name="M:Minio.RequestExtensions.WrapperPutAsync(Minio.IMinioClient,System.String,System.Net.Http.StreamContent)">
  2318. <summary>
  2319. Runs httpClient's PutObjectAsync method
  2320. </summary>
  2321. </member>
  2322. <member name="M:Minio.RequestExtensions.ExecuteTaskAsync(Minio.IMinioClient,System.Collections.Generic.IEnumerable{Minio.Handlers.IApiResponseErrorHandler},Minio.HttpRequestMessageBuilder,System.Boolean,System.Threading.CancellationToken)">
  2323. <summary>
  2324. Actual doer that executes the request on the server
  2325. </summary>
  2326. <param name="minioClient"></param>
  2327. <param name="errorHandlers">List of handlers to override default handling</param>
  2328. <param name="requestMessageBuilder">The build of HttpRequestMessageBuilder </param>
  2329. <param name="isSts">boolean; if true role credentials, otherwise IAM user</param>
  2330. <param name="cancellationToken">Optional cancellation token to cancel the operation</param>
  2331. <returns>ResponseResult</returns>
  2332. </member>
  2333. <member name="M:Minio.RequestExtensions.CreateRequest``1(Minio.IMinioClient,Minio.DataModel.Args.BucketArgs{``0})">
  2334. <summary>
  2335. Constructs a HttpRequestMessageBuilder using bucket/object names from Args.
  2336. Calls overloaded CreateRequest method.
  2337. </summary>
  2338. <param name="minioClient"></param>
  2339. <param name="args">The direct descendant of BucketArgs class, args with populated values from Input</param>
  2340. <returns>A HttpRequestMessageBuilder</returns>
  2341. </member>
  2342. <member name="M:Minio.RequestExtensions.CreateRequest``1(Minio.IMinioClient,Minio.DataModel.Args.ObjectArgs{``0})">
  2343. <summary>
  2344. Constructs a HttpRequestMessage using bucket/object names from Args.
  2345. Calls overloaded CreateRequest method.
  2346. </summary>
  2347. <param name="minioClient"></param>
  2348. <param name="args">The direct descendant of ObjectArgs class, args with populated values from Input</param>
  2349. <returns>A HttpRequestMessage</returns>
  2350. </member>
  2351. <member name="M:Minio.RequestExtensions.CreateRequest(Minio.IMinioClient,System.Net.Http.HttpMethod,System.String,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.String,System.ReadOnlyMemory{System.Byte},System.String,System.Boolean)">
  2352. <summary>
  2353. Constructs an HttpRequestMessage builder. For AWS, this function
  2354. has the side-effect of overriding the baseUrl in the HttpClient
  2355. with region specific host path or virtual style path.
  2356. </summary>
  2357. <param name="minioClient"></param>
  2358. <param name="method">HTTP method</param>
  2359. <param name="bucketName">Bucket Name</param>
  2360. <param name="objectName">Object Name</param>
  2361. <param name="headerMap">headerMap</param>
  2362. <param name="contentType">Content Type</param>
  2363. <param name="body">request body</param>
  2364. <param name="resourcePath">query string</param>
  2365. <param name="isBucketCreationRequest">boolean to define bucket creation</param>
  2366. <returns>A HttpRequestMessage builder</returns>
  2367. <exception cref="T:Minio.Exceptions.BucketNotFoundException">When bucketName is invalid</exception>
  2368. </member>
  2369. <member name="M:Minio.RequestExtensions.ArgsCheck(Minio.DataModel.Args.RequestArgs)">
  2370. <summary>
  2371. Null Check for Args object.
  2372. Expected to be called from CreateRequest
  2373. </summary>
  2374. <param name="args">The child object of Args class</param>
  2375. </member>
  2376. <member name="M:Minio.RequestExtensions.GetRegion(Minio.IMinioClient,System.String)">
  2377. <summary>
  2378. Resolve region of the bucket.
  2379. </summary>
  2380. <param name="minioClient"></param>
  2381. <param name="bucketName"></param>
  2382. <returns></returns>
  2383. </member>
  2384. <member name="M:Minio.RequestExtensions.HandleIfErrorResponse(Minio.IMinioClient,Minio.DataModel.Result.ResponseResult,System.Collections.Generic.IEnumerable{Minio.Handlers.IApiResponseErrorHandler},System.DateTime)">
  2385. <summary>
  2386. Delegate errors to handlers
  2387. </summary>
  2388. <param name="minioClient"></param>
  2389. <param name="response"></param>
  2390. <param name="handlers"></param>
  2391. <param name="startTime"></param>
  2392. </member>
  2393. <member name="T:Minio.V4Authenticator">
  2394. <summary>
  2395. V4Authenticator implements IAuthenticator interface.
  2396. </summary>
  2397. </member>
  2398. <member name="M:Minio.V4Authenticator.#ctor(System.Boolean,System.String,System.String,System.String,System.String)">
  2399. <summary>
  2400. Authenticator constructor.
  2401. </summary>
  2402. <param name="secure"></param>
  2403. <param name="accessKey">Access key id</param>
  2404. <param name="secretKey">Secret access key</param>
  2405. <param name="region">Region if specifically set</param>
  2406. <param name="sessionToken">sessionToken</param>
  2407. </member>
  2408. <member name="M:Minio.V4Authenticator.Authenticate(Minio.HttpRequestMessageBuilder,System.Boolean)">
  2409. <summary>
  2410. Implements Authenticate interface method for IAuthenticator.
  2411. </summary>
  2412. <param name="requestBuilder">Instantiated IRestRequest object</param>
  2413. <param name="isSts">boolean; if true role credentials, otherwise IAM user</param>
  2414. </member>
  2415. <member name="M:Minio.V4Authenticator.GetCredentialString(System.DateTime,System.String,System.Boolean)">
  2416. <summary>
  2417. Get credential string of form {ACCESSID}/date/region/serviceKind/aws4_request.
  2418. </summary>
  2419. <param name="signingDate">Signature initiated date</param>
  2420. <param name="region">Region for the credential string</param>
  2421. <param name="isSts">boolean; if true role credentials, otherwise IAM user</param>
  2422. <returns>Credential string for the authorization header</returns>
  2423. </member>
  2424. <member name="M:Minio.V4Authenticator.GetAuthorizationHeader(System.String,System.String,System.DateTime,System.String,System.Boolean)">
  2425. <summary>
  2426. Constructs an authorization header.
  2427. </summary>
  2428. <param name="signedHeaders">All signed http headers</param>
  2429. <param name="signature">Hexadecimally encoded computed signature</param>
  2430. <param name="signingDate">Date for signature to be signed</param>
  2431. <param name="region">Requested region</param>
  2432. <param name="isSts">boolean; if true role credentials, otherwise IAM user</param>
  2433. <returns>Fully formed authorization header</returns>
  2434. </member>
  2435. <member name="M:Minio.V4Authenticator.GetSignedHeaders(System.Collections.Generic.SortedDictionary{System.String,System.String})">
  2436. <summary>
  2437. Concatenates sorted list of signed http headers.
  2438. </summary>
  2439. <param name="headersToSign">Sorted dictionary of headers to be signed</param>
  2440. <returns>All signed headers</returns>
  2441. </member>
  2442. <member name="M:Minio.V4Authenticator.GetService(System.Boolean)">
  2443. <summary>
  2444. Determines and returns the kind of service
  2445. </summary>
  2446. <param name="isSts">boolean; if true role credentials, otherwise IAM user</param>
  2447. <returns>returns the kind of service as a string</returns>
  2448. </member>
  2449. <member name="M:Minio.V4Authenticator.GenerateSigningKey(System.String,System.DateTime,System.Boolean)">
  2450. <summary>
  2451. Generates signing key based on the region and date.
  2452. </summary>
  2453. <param name="region">Requested region</param>
  2454. <param name="signingDate">Date for signature to be signed</param>
  2455. <param name="isSts">boolean; if true role credentials, otherwise IAM user</param>
  2456. <returns>bytes of computed hmac</returns>
  2457. </member>
  2458. <member name="M:Minio.V4Authenticator.SignHmac(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Byte})">
  2459. <summary>
  2460. Compute hmac of input content with key.
  2461. </summary>
  2462. <param name="key">Hmac key</param>
  2463. <param name="content">Bytes to be hmac computed</param>
  2464. <returns>Computed hmac of input content</returns>
  2465. </member>
  2466. <member name="M:Minio.V4Authenticator.GetStringToSign(System.String,System.DateTime,System.String,System.Boolean)">
  2467. <summary>
  2468. Get string to sign.
  2469. </summary>
  2470. <param name="region">Requested region</param>
  2471. <param name="signingDate">Date for signature to be signed</param>
  2472. <param name="canonicalRequestHash">Hexadecimal encoded sha256 checksum of canonicalRequest</param>
  2473. <param name="isSts">boolean; if true role credentials, otherwise IAM user</param>
  2474. <returns>String to sign</returns>
  2475. </member>
  2476. <member name="M:Minio.V4Authenticator.GetScope(System.String,System.DateTime,System.Boolean)">
  2477. <summary>
  2478. Get scope.
  2479. </summary>
  2480. <param name="region">Requested region</param>
  2481. <param name="signingDate">Date for signature to be signed</param>
  2482. <param name="isSts">boolean; if true role credentials, otherwise IAM user</param>
  2483. <returns>Scope string</returns>
  2484. </member>
  2485. <member name="M:Minio.V4Authenticator.ComputeSha256(System.ReadOnlySpan{System.Byte})">
  2486. <summary>
  2487. Compute sha256 checksum.
  2488. </summary>
  2489. <param name="body">Bytes body</param>
  2490. <returns>Bytes of sha256 checksum</returns>
  2491. </member>
  2492. <member name="M:Minio.V4Authenticator.BytesToHex(System.ReadOnlySpan{System.Byte})">
  2493. <summary>
  2494. Convert bytes to hexadecimal string.
  2495. </summary>
  2496. <param name="checkSum">Bytes of any checksum</param>
  2497. <returns>Hexlified string of input bytes</returns>
  2498. </member>
  2499. <member name="M:Minio.V4Authenticator.PresignPostSignature(System.String,System.DateTime,System.String)">
  2500. <summary>
  2501. Generate signature for post policy.
  2502. </summary>
  2503. <param name="region">Requested region</param>
  2504. <param name="signingDate">Date for signature to be signed</param>
  2505. <param name="policyBase64">Base64 encoded policy JSON</param>
  2506. <returns>Computed signature</returns>
  2507. </member>
  2508. <member name="M:Minio.V4Authenticator.PresignURL(Minio.HttpRequestMessageBuilder,System.Int32,System.String,System.String,System.Nullable{System.DateTime})">
  2509. <summary>
  2510. Presigns any input client object with a requested expiry.
  2511. </summary>
  2512. <param name="requestBuilder">Instantiated requestBuilder</param>
  2513. <param name="expires">Expiration in seconds</param>
  2514. <param name="region">Region of storage</param>
  2515. <param name="sessionToken">Value for session token</param>
  2516. <param name="reqDate"> Optional requestBuilder date and time in UTC</param>
  2517. <returns>Presigned url</returns>
  2518. </member>
  2519. <member name="M:Minio.V4Authenticator.GetPresignCanonicalRequest(System.Net.Http.HttpMethod,System.Uri,System.Collections.Generic.SortedDictionary{System.String,System.String})">
  2520. <summary>
  2521. Get presign canonical requestBuilder.
  2522. </summary>
  2523. <param name="requestMethod">HTTP method used for this requestBuilder</param>
  2524. <param name="uri">
  2525. Full url for this requestBuilder, including all query parameters except for headers and
  2526. X-Amz-Signature
  2527. </param>
  2528. <param name="headersToSign">The key-value of headers.</param>
  2529. <returns>Presigned canonical requestBuilder</returns>
  2530. </member>
  2531. <member name="M:Minio.V4Authenticator.GetCanonicalRequest(Minio.HttpRequestMessageBuilder,System.Collections.Generic.SortedDictionary{System.String,System.String})">
  2532. <summary>
  2533. Get canonical requestBuilder.
  2534. </summary>
  2535. <param name="requestBuilder">Instantiated requestBuilder object</param>
  2536. <param name="headersToSign">Dictionary of http headers to be signed</param>
  2537. <returns>Canonical Request</returns>
  2538. </member>
  2539. <member name="M:Minio.V4Authenticator.GetHeadersToSign(Minio.HttpRequestMessageBuilder)">
  2540. <summary>
  2541. Get headers to be signed.
  2542. </summary>
  2543. <param name="requestBuilder">Instantiated requesst</param>
  2544. <returns>Sorted dictionary of headers to be signed</returns>
  2545. </member>
  2546. <member name="M:Minio.V4Authenticator.SetDateHeader(Minio.HttpRequestMessageBuilder,System.DateTime)">
  2547. <summary>
  2548. Sets 'x-amz-date' http header.
  2549. </summary>
  2550. <param name="requestBuilder">Instantiated requestBuilder object</param>
  2551. <param name="signingDate">Date for signature to be signed</param>
  2552. </member>
  2553. <member name="M:Minio.V4Authenticator.SetHostHeader(Minio.HttpRequestMessageBuilder,System.String)">
  2554. <summary>
  2555. Set 'Host' http header.
  2556. </summary>
  2557. <param name="requestBuilder">Instantiated requestBuilder object</param>
  2558. <param name="hostUrl">Host url</param>
  2559. </member>
  2560. <member name="M:Minio.V4Authenticator.SetSessionTokenHeader(Minio.HttpRequestMessageBuilder,System.String)">
  2561. <summary>
  2562. Set 'X-Amz-Security-Token' http header.
  2563. </summary>
  2564. <param name="requestBuilder">Instantiated requestBuilder object</param>
  2565. <param name="sessionToken">session token</param>
  2566. </member>
  2567. <member name="M:Minio.V4Authenticator.SetContentSha256(Minio.HttpRequestMessageBuilder,System.Boolean)">
  2568. <summary>
  2569. Set 'x-amz-content-sha256' http header.
  2570. </summary>
  2571. <param name="requestBuilder">Instantiated requestBuilder object</param>
  2572. <param name="isSts">boolean; if true role credentials, otherwise IAM user</param>
  2573. </member>
  2574. <member name="M:PolyfillExtensions.WaitAsync``1(System.Threading.Tasks.Task{``0},System.Threading.CancellationToken)">
  2575. <summary>
  2576. Gets a <see cref="T:System.Threading.Tasks.Task`1"/> that will complete when the <paramref name="task"/> completes or when the specified <paramref name="cancellationToken"/> has cancellation requested.
  2577. </summary>
  2578. <typeparam name="TResult">The type of the task result.</typeparam>
  2579. <param name="task">The task to wait on for completion.</param>
  2580. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/> to monitor for a cancellation request.</param>
  2581. <returns>The <see cref="T:System.Threading.Tasks.Task`1"/> representing the asynchronous wait.</returns>
  2582. </member>
  2583. <member name="T:System.Collections.Generic.PriorityQueue`2">
  2584. <summary>
  2585. Represents a min priority queue.
  2586. </summary>
  2587. <typeparam name="TElement">Specifies the type of elements in the queue.</typeparam>
  2588. <typeparam name="TPriority">Specifies the type of priority associated with enqueued elements.</typeparam>
  2589. <remarks>
  2590. Implements an array-backed quaternary min-heap. Each element is enqueued with an associated priority
  2591. that determines the dequeue order: elements with the lowest priority get dequeued first.
  2592. </remarks>
  2593. </member>
  2594. <member name="F:System.Collections.Generic.PriorityQueue`2._nodes">
  2595. <summary>
  2596. Represents an implicit heap-ordered complete d-ary tree, stored as an array.
  2597. </summary>
  2598. </member>
  2599. <member name="F:System.Collections.Generic.PriorityQueue`2._comparer">
  2600. <summary>
  2601. Custom comparer used to order the heap.
  2602. </summary>
  2603. </member>
  2604. <member name="F:System.Collections.Generic.PriorityQueue`2._unorderedItems">
  2605. <summary>
  2606. Lazily-initialized collection used to expose the contents of the queue.
  2607. </summary>
  2608. </member>
  2609. <member name="F:System.Collections.Generic.PriorityQueue`2._size">
  2610. <summary>
  2611. The number of nodes in the heap.
  2612. </summary>
  2613. </member>
  2614. <member name="F:System.Collections.Generic.PriorityQueue`2._version">
  2615. <summary>
  2616. Version updated on mutation to help validate enumerators operate on a consistent state.
  2617. </summary>
  2618. </member>
  2619. <member name="F:System.Collections.Generic.PriorityQueue`2.Arity">
  2620. <summary>
  2621. Specifies the arity of the d-ary heap, which here is quaternary.
  2622. It is assumed that this value is a power of 2.
  2623. </summary>
  2624. </member>
  2625. <member name="F:System.Collections.Generic.PriorityQueue`2.Log2Arity">
  2626. <summary>
  2627. The binary logarithm of <see cref="F:System.Collections.Generic.PriorityQueue`2.Arity" />.
  2628. </summary>
  2629. </member>
  2630. <member name="M:System.Collections.Generic.PriorityQueue`2.#ctor">
  2631. <summary>
  2632. Initializes a new instance of the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> class.
  2633. </summary>
  2634. </member>
  2635. <member name="M:System.Collections.Generic.PriorityQueue`2.#ctor(System.Int32)">
  2636. <summary>
  2637. Initializes a new instance of the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> class
  2638. with the specified initial capacity.
  2639. </summary>
  2640. <param name="initialCapacity">Initial capacity to allocate in the underlying heap array.</param>
  2641. <exception cref="T:System.ArgumentOutOfRangeException">
  2642. The specified <paramref name="initialCapacity"/> was negative.
  2643. </exception>
  2644. </member>
  2645. <member name="M:System.Collections.Generic.PriorityQueue`2.#ctor(System.Collections.Generic.IComparer{`1})">
  2646. <summary>
  2647. Initializes a new instance of the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> class
  2648. with the specified custom priority comparer.
  2649. </summary>
  2650. <param name="comparer">
  2651. Custom comparer dictating the ordering of elements.
  2652. Uses <see cref="P:System.Collections.Generic.Comparer`1.Default" /> if the argument is <see langword="null"/>.
  2653. </param>
  2654. </member>
  2655. <member name="M:System.Collections.Generic.PriorityQueue`2.#ctor(System.Int32,System.Collections.Generic.IComparer{`1})">
  2656. <summary>
  2657. Initializes a new instance of the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> class
  2658. with the specified initial capacity and custom priority comparer.
  2659. </summary>
  2660. <param name="initialCapacity">Initial capacity to allocate in the underlying heap array.</param>
  2661. <param name="comparer">
  2662. Custom comparer dictating the ordering of elements.
  2663. Uses <see cref="P:System.Collections.Generic.Comparer`1.Default" /> if the argument is <see langword="null"/>.
  2664. </param>
  2665. <exception cref="T:System.ArgumentOutOfRangeException">
  2666. The specified <paramref name="initialCapacity"/> was negative.
  2667. </exception>
  2668. </member>
  2669. <member name="M:System.Collections.Generic.PriorityQueue`2.#ctor(System.Collections.Generic.IEnumerable{System.ValueTuple{`0,`1}})">
  2670. <summary>
  2671. Initializes a new instance of the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> class
  2672. that is populated with the specified elements and priorities.
  2673. </summary>
  2674. <param name="items">The pairs of elements and priorities with which to populate the queue.</param>
  2675. <exception cref="T:System.ArgumentNullException">
  2676. The specified <paramref name="items"/> argument was <see langword="null"/>.
  2677. </exception>
  2678. <remarks>
  2679. Constructs the heap using a heapify operation,
  2680. which is generally faster than enqueuing individual elements sequentially.
  2681. </remarks>
  2682. </member>
  2683. <member name="M:System.Collections.Generic.PriorityQueue`2.#ctor(System.Collections.Generic.IEnumerable{System.ValueTuple{`0,`1}},System.Collections.Generic.IComparer{`1})">
  2684. <summary>
  2685. Initializes a new instance of the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> class
  2686. that is populated with the specified elements and priorities,
  2687. and with the specified custom priority comparer.
  2688. </summary>
  2689. <param name="items">The pairs of elements and priorities with which to populate the queue.</param>
  2690. <param name="comparer">
  2691. Custom comparer dictating the ordering of elements.
  2692. Uses <see cref="P:System.Collections.Generic.Comparer`1.Default" /> if the argument is <see langword="null"/>.
  2693. </param>
  2694. <exception cref="T:System.ArgumentNullException">
  2695. The specified <paramref name="items"/> argument was <see langword="null"/>.
  2696. </exception>
  2697. <remarks>
  2698. Constructs the heap using a heapify operation,
  2699. which is generally faster than enqueuing individual elements sequentially.
  2700. </remarks>
  2701. </member>
  2702. <member name="P:System.Collections.Generic.PriorityQueue`2.Count">
  2703. <summary>
  2704. Gets the number of elements contained in the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.
  2705. </summary>
  2706. </member>
  2707. <member name="P:System.Collections.Generic.PriorityQueue`2.Comparer">
  2708. <summary>
  2709. Gets the priority comparer used by the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.
  2710. </summary>
  2711. </member>
  2712. <member name="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems">
  2713. <summary>
  2714. Gets a collection that enumerates the elements of the queue in an unordered manner.
  2715. </summary>
  2716. <remarks>
  2717. The enumeration does not order items by priority, since that would require N * log(N) time and N space.
  2718. Items are instead enumerated following the internal array heap layout.
  2719. </remarks>
  2720. </member>
  2721. <member name="M:System.Collections.Generic.PriorityQueue`2.Enqueue(`0,`1)">
  2722. <summary>
  2723. Adds the specified element with associated priority to the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.
  2724. </summary>
  2725. <param name="element">The element to add to the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.</param>
  2726. <param name="priority">The priority with which to associate the new element.</param>
  2727. </member>
  2728. <member name="M:System.Collections.Generic.PriorityQueue`2.Peek">
  2729. <summary>
  2730. Returns the minimal element from the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> without removing it.
  2731. </summary>
  2732. <exception cref="T:System.InvalidOperationException">The <see cref="T:System.Collections.Generic.PriorityQueue`2"/> is empty.</exception>
  2733. <returns>The minimal element of the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.</returns>
  2734. </member>
  2735. <member name="M:System.Collections.Generic.PriorityQueue`2.Dequeue">
  2736. <summary>
  2737. Removes and returns the minimal element from the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.
  2738. </summary>
  2739. <exception cref="T:System.InvalidOperationException">The queue is empty.</exception>
  2740. <returns>The minimal element of the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.</returns>
  2741. </member>
  2742. <member name="M:System.Collections.Generic.PriorityQueue`2.DequeueEnqueue(`0,`1)">
  2743. <summary>
  2744. Removes the minimal element and then immediately adds the specified element with associated priority to the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>,
  2745. </summary>
  2746. <param name="element">The element to add to the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.</param>
  2747. <param name="priority">The priority with which to associate the new element.</param>
  2748. <exception cref="T:System.InvalidOperationException">The queue is empty.</exception>
  2749. <returns>The minimal element removed before performing the enqueue operation.</returns>
  2750. <remarks>
  2751. Implements an extract-then-insert heap operation that is generally more efficient
  2752. than sequencing Dequeue and Enqueue operations: in the worst case scenario only one
  2753. shift-down operation is required.
  2754. </remarks>
  2755. </member>
  2756. <member name="M:System.Collections.Generic.PriorityQueue`2.TryDequeue(`0@,`1@)">
  2757. <summary>
  2758. Removes the minimal element from the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>,
  2759. and copies it to the <paramref name="element"/> parameter,
  2760. and its associated priority to the <paramref name="priority"/> parameter.
  2761. </summary>
  2762. <param name="element">The removed element.</param>
  2763. <param name="priority">The priority associated with the removed element.</param>
  2764. <returns>
  2765. <see langword="true"/> if the element is successfully removed;
  2766. <see langword="false"/> if the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> is empty.
  2767. </returns>
  2768. </member>
  2769. <member name="M:System.Collections.Generic.PriorityQueue`2.TryPeek(`0@,`1@)">
  2770. <summary>
  2771. Returns a value that indicates whether there is a minimal element in the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>,
  2772. and if one is present, copies it to the <paramref name="element"/> parameter,
  2773. and its associated priority to the <paramref name="priority"/> parameter.
  2774. The element is not removed from the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.
  2775. </summary>
  2776. <param name="element">The minimal element in the queue.</param>
  2777. <param name="priority">The priority associated with the minimal element.</param>
  2778. <returns>
  2779. <see langword="true"/> if there is a minimal element;
  2780. <see langword="false"/> if the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> is empty.
  2781. </returns>
  2782. </member>
  2783. <member name="M:System.Collections.Generic.PriorityQueue`2.EnqueueDequeue(`0,`1)">
  2784. <summary>
  2785. Adds the specified element with associated priority to the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>,
  2786. and immediately removes the minimal element, returning the result.
  2787. </summary>
  2788. <param name="element">The element to add to the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.</param>
  2789. <param name="priority">The priority with which to associate the new element.</param>
  2790. <returns>The minimal element removed after the enqueue operation.</returns>
  2791. <remarks>
  2792. Implements an insert-then-extract heap operation that is generally more efficient
  2793. than sequencing Enqueue and Dequeue operations: in the worst case scenario only one
  2794. shift-down operation is required.
  2795. </remarks>
  2796. </member>
  2797. <member name="M:System.Collections.Generic.PriorityQueue`2.EnqueueRange(System.Collections.Generic.IEnumerable{System.ValueTuple{`0,`1}})">
  2798. <summary>
  2799. Enqueues a sequence of element/priority pairs to the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.
  2800. </summary>
  2801. <param name="items">The pairs of elements and priorities to add to the queue.</param>
  2802. <exception cref="T:System.ArgumentNullException">
  2803. The specified <paramref name="items"/> argument was <see langword="null"/>.
  2804. </exception>
  2805. </member>
  2806. <member name="M:System.Collections.Generic.PriorityQueue`2.EnqueueRange(System.Collections.Generic.IEnumerable{`0},`1)">
  2807. <summary>
  2808. Enqueues a sequence of elements pairs to the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>,
  2809. all associated with the specified priority.
  2810. </summary>
  2811. <param name="elements">The elements to add to the queue.</param>
  2812. <param name="priority">The priority to associate with the new elements.</param>
  2813. <exception cref="T:System.ArgumentNullException">
  2814. The specified <paramref name="elements"/> argument was <see langword="null"/>.
  2815. </exception>
  2816. </member>
  2817. <member name="M:System.Collections.Generic.PriorityQueue`2.Clear">
  2818. <summary>
  2819. Removes all items from the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.
  2820. </summary>
  2821. </member>
  2822. <member name="M:System.Collections.Generic.PriorityQueue`2.EnsureCapacity(System.Int32)">
  2823. <summary>
  2824. Ensures that the <see cref="T:System.Collections.Generic.PriorityQueue`2"/> can hold up to
  2825. <paramref name="capacity"/> items without further expansion of its backing storage.
  2826. </summary>
  2827. <param name="capacity">The minimum capacity to be used.</param>
  2828. <exception cref="T:System.ArgumentOutOfRangeException">
  2829. The specified <paramref name="capacity"/> is negative.
  2830. </exception>
  2831. <returns>The current capacity of the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>.</returns>
  2832. </member>
  2833. <member name="M:System.Collections.Generic.PriorityQueue`2.TrimExcess">
  2834. <summary>
  2835. Sets the capacity to the actual number of items in the <see cref="T:System.Collections.Generic.PriorityQueue`2"/>,
  2836. if that is less than 90 percent of current capacity.
  2837. </summary>
  2838. <remarks>
  2839. This method can be used to minimize a collection's memory overhead
  2840. if no new elements will be added to the collection.
  2841. </remarks>
  2842. </member>
  2843. <member name="M:System.Collections.Generic.PriorityQueue`2.Grow(System.Int32)">
  2844. <summary>
  2845. Grows the priority queue to match the specified min capacity.
  2846. </summary>
  2847. </member>
  2848. <member name="M:System.Collections.Generic.PriorityQueue`2.RemoveRootNode">
  2849. <summary>
  2850. Removes the node from the root of the heap
  2851. </summary>
  2852. </member>
  2853. <member name="M:System.Collections.Generic.PriorityQueue`2.GetParentIndex(System.Int32)">
  2854. <summary>
  2855. Gets the index of an element's parent.
  2856. </summary>
  2857. </member>
  2858. <member name="M:System.Collections.Generic.PriorityQueue`2.GetFirstChildIndex(System.Int32)">
  2859. <summary>
  2860. Gets the index of the first child of an element.
  2861. </summary>
  2862. </member>
  2863. <member name="M:System.Collections.Generic.PriorityQueue`2.Heapify">
  2864. <summary>
  2865. Converts an unordered list into a heap.
  2866. </summary>
  2867. </member>
  2868. <member name="M:System.Collections.Generic.PriorityQueue`2.MoveUpDefaultComparer(System.ValueTuple{`0,`1},System.Int32)">
  2869. <summary>
  2870. Moves a node up in the tree to restore heap order.
  2871. </summary>
  2872. </member>
  2873. <member name="M:System.Collections.Generic.PriorityQueue`2.MoveUpCustomComparer(System.ValueTuple{`0,`1},System.Int32)">
  2874. <summary>
  2875. Moves a node up in the tree to restore heap order.
  2876. </summary>
  2877. </member>
  2878. <member name="M:System.Collections.Generic.PriorityQueue`2.MoveDownDefaultComparer(System.ValueTuple{`0,`1},System.Int32)">
  2879. <summary>
  2880. Moves a node down in the tree to restore heap order.
  2881. </summary>
  2882. </member>
  2883. <member name="M:System.Collections.Generic.PriorityQueue`2.MoveDownCustomComparer(System.ValueTuple{`0,`1},System.Int32)">
  2884. <summary>
  2885. Moves a node down in the tree to restore heap order.
  2886. </summary>
  2887. </member>
  2888. <member name="M:System.Collections.Generic.PriorityQueue`2.InitializeComparer(System.Collections.Generic.IComparer{`1})">
  2889. <summary>
  2890. Initializes the custom comparer to be used internally by the heap.
  2891. </summary>
  2892. </member>
  2893. <member name="T:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection">
  2894. <summary>
  2895. Enumerates the contents of a <see cref="T:System.Collections.Generic.PriorityQueue`2"/>, without any ordering guarantees.
  2896. </summary>
  2897. </member>
  2898. <member name="T:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator">
  2899. <summary>
  2900. Enumerates the element and priority pairs of a <see cref="T:System.Collections.Generic.PriorityQueue`2"/>,
  2901. without any ordering guarantees.
  2902. </summary>
  2903. </member>
  2904. <member name="M:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator.Dispose">
  2905. <summary>
  2906. Releases all resources used by the <see cref="T:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator"/>.
  2907. </summary>
  2908. </member>
  2909. <member name="M:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator.MoveNext">
  2910. <summary>
  2911. Advances the enumerator to the next element of the <see cref="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems"/>.
  2912. </summary>
  2913. <returns><see langword="true"/> if the enumerator was successfully advanced to the next element; <see langword="false"/> if the enumerator has passed the end of the collection.</returns>
  2914. </member>
  2915. <member name="P:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator.Current">
  2916. <summary>
  2917. Gets the element at the current position of the enumerator.
  2918. </summary>
  2919. </member>
  2920. <member name="M:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.GetEnumerator">
  2921. <summary>
  2922. Returns an enumerator that iterates through the <see cref="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems"/>.
  2923. </summary>
  2924. <returns>An <see cref="T:System.Collections.Generic.PriorityQueue`2.UnorderedItemsCollection.Enumerator"/> for the <see cref="P:System.Collections.Generic.PriorityQueue`2.UnorderedItems"/>.</returns>
  2925. </member>
  2926. <member name="T:System.Collections.Generic.ReferenceEqualityComparer">
  2927. <summary>
  2928. An <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> that uses reference equality (<see cref="M:System.Object.ReferenceEquals(System.Object,System.Object)"/>)
  2929. instead of value equality (<see cref="M:System.Object.Equals(System.Object)"/>) when comparing two object instances.
  2930. </summary>
  2931. <remarks>
  2932. The <see cref="T:System.Collections.Generic.ReferenceEqualityComparer"/> type cannot be instantiated. Instead, use the <see cref="P:System.Collections.Generic.ReferenceEqualityComparer.Instance"/> property
  2933. to access the singleton instance of this type.
  2934. </remarks>
  2935. </member>
  2936. <member name="P:System.Collections.Generic.ReferenceEqualityComparer.Instance">
  2937. <summary>
  2938. Gets the singleton <see cref="T:System.Collections.Generic.ReferenceEqualityComparer"/> instance.
  2939. </summary>
  2940. </member>
  2941. <member name="M:System.Collections.Generic.ReferenceEqualityComparer.Equals(System.Object,System.Object)">
  2942. <summary>
  2943. Determines whether two object references refer to the same object instance.
  2944. </summary>
  2945. <param name="x">The first object to compare.</param>
  2946. <param name="y">The second object to compare.</param>
  2947. <returns>
  2948. <see langword="true"/> if both <paramref name="x"/> and <paramref name="y"/> refer to the same object instance
  2949. or if both are <see langword="null"/>; otherwise, <see langword="false"/>.
  2950. </returns>
  2951. <remarks>
  2952. This API is a wrapper around <see cref="M:System.Object.ReferenceEquals(System.Object,System.Object)"/>.
  2953. It is not necessarily equivalent to calling <see cref="M:System.Object.Equals(System.Object,System.Object)"/>.
  2954. </remarks>
  2955. </member>
  2956. <member name="M:System.Collections.Generic.ReferenceEqualityComparer.GetHashCode(System.Object)">
  2957. <summary>
  2958. Returns a hash code for the specified object. The returned hash code is based on the object
  2959. identity, not on the contents of the object.
  2960. </summary>
  2961. <param name="obj">The object for which to retrieve the hash code.</param>
  2962. <returns>A hash code for the identity of <paramref name="obj"/>.</returns>
  2963. <remarks>
  2964. This API is a wrapper around <see cref="M:System.Runtime.CompilerServices.RuntimeHelpers.GetHashCode(System.Object)"/>.
  2965. It is not necessarily equivalent to calling <see cref="M:System.Object.GetHashCode"/>.
  2966. </remarks>
  2967. </member>
  2968. <member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
  2969. <summary>
  2970. Specifies that <see langword="null"/> is allowed as an input even if the
  2971. corresponding type disallows it.
  2972. </summary>
  2973. <summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
  2974. </member>
  2975. <member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
  2976. <summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
  2977. </member>
  2978. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
  2979. <summary>Applied to a method that will never return under any circumstance.</summary>
  2980. </member>
  2981. <member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
  2982. <summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
  2983. </member>
  2984. <member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
  2985. <summary>Initializes the attribute with the specified parameter value.</summary>
  2986. <param name="parameterValue">
  2987. The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
  2988. the associated parameter matches this value.
  2989. </param>
  2990. </member>
  2991. <member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
  2992. <summary>Gets the condition parameter value.</summary>
  2993. </member>
  2994. <member name="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute">
  2995. <summary>
  2996. States a dependency that one member has on another.
  2997. </summary>
  2998. <remarks>
  2999. This can be used to inform tooling of a dependency that is otherwise not evident purely from
  3000. metadata and IL, for example a member relied on via reflection.
  3001. </remarks>
  3002. </member>
  3003. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String)">
  3004. <summary>
  3005. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  3006. with the specified signature of a member on the same type as the consumer.
  3007. </summary>
  3008. <param name="memberSignature">The signature of the member depended on.</param>
  3009. </member>
  3010. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.Type)">
  3011. <summary>
  3012. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  3013. with the specified signature of a member on a <see cref="T:System.Type"/>.
  3014. </summary>
  3015. <param name="memberSignature">The signature of the member depended on.</param>
  3016. <param name="type">The <see cref="T:System.Type"/> containing <paramref name="memberSignature"/>.</param>
  3017. </member>
  3018. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.String,System.String)">
  3019. <summary>
  3020. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  3021. with the specified signature of a member on a type in an assembly.
  3022. </summary>
  3023. <param name="memberSignature">The signature of the member depended on.</param>
  3024. <param name="typeName">The full name of the type containing the specified member.</param>
  3025. <param name="assemblyName">The assembly name of the type containing the specified member.</param>
  3026. </member>
  3027. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.Type)">
  3028. <summary>
  3029. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  3030. with the specified types of members on a <see cref="T:System.Type"/>.
  3031. </summary>
  3032. <param name="memberTypes">The types of members depended on.</param>
  3033. <param name="type">The <see cref="T:System.Type"/> containing the specified members.</param>
  3034. </member>
  3035. <member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.String,System.String)">
  3036. <summary>
  3037. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
  3038. with the specified types of members on a type in an assembly.
  3039. </summary>
  3040. <param name="memberTypes">The types of members depended on.</param>
  3041. <param name="typeName">The full name of the type containing the specified members.</param>
  3042. <param name="assemblyName">The assembly name of the type containing the specified members.</param>
  3043. </member>
  3044. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature">
  3045. <summary>
  3046. Gets the signature of the member depended on.
  3047. </summary>
  3048. <remarks>
  3049. Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
  3050. must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
  3051. </remarks>
  3052. </member>
  3053. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes">
  3054. <summary>
  3055. Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
  3056. of members depended on.
  3057. </summary>
  3058. <remarks>
  3059. Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
  3060. must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
  3061. </remarks>
  3062. </member>
  3063. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type">
  3064. <summary>
  3065. Gets the <see cref="T:System.Type"/> containing the specified member.
  3066. </summary>
  3067. <remarks>
  3068. If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
  3069. the type of the consumer is assumed.
  3070. </remarks>
  3071. </member>
  3072. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName">
  3073. <summary>
  3074. Gets the full name of the type containing the specified member.
  3075. </summary>
  3076. <remarks>
  3077. If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
  3078. the type of the consumer is assumed.
  3079. </remarks>
  3080. </member>
  3081. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName">
  3082. <summary>
  3083. Gets the assembly name of the specified type.
  3084. </summary>
  3085. <remarks>
  3086. <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName"/> is only valid when <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> is specified.
  3087. </remarks>
  3088. </member>
  3089. <member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Condition">
  3090. <summary>
  3091. Gets or sets the condition in which the dependency is applicable, e.g. "DEBUG".
  3092. </summary>
  3093. </member>
  3094. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
  3095. <summary>
  3096. Specifies the types of members that are dynamically accessed.
  3097. This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
  3098. bitwise combination of its member values.
  3099. </summary>
  3100. </member>
  3101. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
  3102. <summary>
  3103. Specifies no members.
  3104. </summary>
  3105. </member>
  3106. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
  3107. <summary>
  3108. Specifies the default, parameterless public constructor.
  3109. </summary>
  3110. </member>
  3111. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
  3112. <summary>
  3113. Specifies all public constructors.
  3114. </summary>
  3115. </member>
  3116. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
  3117. <summary>
  3118. Specifies all non-public constructors.
  3119. </summary>
  3120. </member>
  3121. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
  3122. <summary>
  3123. Specifies all public methods.
  3124. </summary>
  3125. </member>
  3126. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
  3127. <summary>
  3128. Specifies all non-public methods.
  3129. </summary>
  3130. </member>
  3131. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
  3132. <summary>
  3133. Specifies all public fields.
  3134. </summary>
  3135. </member>
  3136. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
  3137. <summary>
  3138. Specifies all non-public fields.
  3139. </summary>
  3140. </member>
  3141. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
  3142. <summary>
  3143. Specifies all public nested types.
  3144. </summary>
  3145. </member>
  3146. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
  3147. <summary>
  3148. Specifies all non-public nested types.
  3149. </summary>
  3150. </member>
  3151. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
  3152. <summary>
  3153. Specifies all public properties.
  3154. </summary>
  3155. </member>
  3156. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
  3157. <summary>
  3158. Specifies all non-public properties.
  3159. </summary>
  3160. </member>
  3161. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
  3162. <summary>
  3163. Specifies all public events.
  3164. </summary>
  3165. </member>
  3166. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
  3167. <summary>
  3168. Specifies all non-public events.
  3169. </summary>
  3170. </member>
  3171. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
  3172. <summary>
  3173. Specifies all interfaces implemented by the type.
  3174. </summary>
  3175. </member>
  3176. <member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
  3177. <summary>
  3178. Specifies all members.
  3179. </summary>
  3180. </member>
  3181. <member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
  3182. <summary>
  3183. Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
  3184. for example through <see cref="N:System.Reflection"/>.
  3185. </summary>
  3186. <remarks>
  3187. This allows tools to understand which members are being accessed during the execution
  3188. of a program.
  3189. This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
  3190. When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
  3191. that the string represents a fully qualified type name.
  3192. When this attribute is applied to a class, interface, or struct, the members specified
  3193. can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
  3194. <see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
  3195. If the attribute is applied to a method it's treated as a special case and it implies
  3196. the attribute should be applied to the "this" parameter of the method. As such the attribute
  3197. should only be used on instance methods of types assignable to System.Type (or string, but no methods
  3198. will use it there).
  3199. </remarks>
  3200. </member>
  3201. <member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
  3202. <summary>
  3203. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
  3204. with the specified member types.
  3205. </summary>
  3206. <param name="memberTypes">The types of members dynamically accessed.</param>
  3207. </member>
  3208. <member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
  3209. <summary>
  3210. Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
  3211. of members dynamically accessed.
  3212. </summary>
  3213. </member>
  3214. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
  3215. <summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
  3216. </member>
  3217. <member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
  3218. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
  3219. </member>
  3220. <member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
  3221. <summary>Initializes the attribute with the specified return value condition.</summary>
  3222. <param name="returnValue">
  3223. The return value condition. If the method returns this value, the associated parameter may be null.
  3224. </param>
  3225. </member>
  3226. <member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
  3227. <summary>Gets the return value condition.</summary>
  3228. </member>
  3229. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
  3230. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
  3231. </member>
  3232. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
  3233. <summary>Initializes the attribute with a field or property member.</summary>
  3234. <param name="member">
  3235. The field or property member that is promised to be not-null.
  3236. </param>
  3237. </member>
  3238. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
  3239. <summary>Initializes the attribute with the list of field and property members.</summary>
  3240. <param name="members">
  3241. The list of field and property members that are promised to be not-null.
  3242. </param>
  3243. </member>
  3244. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
  3245. <summary>Gets field or property member names.</summary>
  3246. </member>
  3247. <member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
  3248. <summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
  3249. </member>
  3250. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
  3251. <summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
  3252. <param name="returnValue">
  3253. The return value condition. If the method returns this value, the associated parameter will not be null.
  3254. </param>
  3255. <param name="member">
  3256. The field or property member that is promised to be not-null.
  3257. </param>
  3258. </member>
  3259. <member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
  3260. <summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
  3261. <param name="returnValue">
  3262. The return value condition. If the method returns this value, the associated parameter will not be null.
  3263. </param>
  3264. <param name="members">
  3265. The list of field and property members that are promised to be not-null.
  3266. </param>
  3267. </member>
  3268. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
  3269. <summary>Gets the return value condition.</summary>
  3270. </member>
  3271. <member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
  3272. <summary>Gets field or property member names.</summary>
  3273. </member>
  3274. <member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
  3275. <summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
  3276. </member>
  3277. <member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
  3278. <summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
  3279. </member>
  3280. <member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
  3281. <summary>Initializes the attribute with the associated parameter name.</summary>
  3282. <param name="parameterName">
  3283. The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
  3284. </param>
  3285. </member>
  3286. <member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
  3287. <summary>Gets the associated parameter name.</summary>
  3288. </member>
  3289. <member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
  3290. <summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
  3291. </member>
  3292. <member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
  3293. <summary>Initializes the attribute with the specified return value condition.</summary>
  3294. <param name="returnValue">
  3295. The return value condition. If the method returns this value, the associated parameter will not be null.
  3296. </param>
  3297. </member>
  3298. <member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
  3299. <summary>Gets the return value condition.</summary>
  3300. </member>
  3301. <member name="T:System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute">
  3302. <summary>
  3303. Indicates that the specified member requires assembly files to be on disk.
  3304. </summary>
  3305. </member>
  3306. <member name="M:System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute.#ctor">
  3307. <summary>
  3308. Initializes a new instance of the <see cref="!:global::System.RequiresAssemblyFilesAttribute"/> class.
  3309. </summary>
  3310. </member>
  3311. <member name="M:System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute.#ctor(System.String)">
  3312. <summary>
  3313. Initializes a new instance of the <see cref="!:global::System.RequiresAssemblyFilesAttribute"/> class.
  3314. </summary>
  3315. <param name="message">
  3316. A message that contains information about the need for assembly files to be on disk.
  3317. </param>
  3318. </member>
  3319. <member name="P:System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute.Message">
  3320. <summary>
  3321. Gets an optional message that contains information about the need for
  3322. assembly files to be on disk.
  3323. </summary>
  3324. </member>
  3325. <member name="P:System.Diagnostics.CodeAnalysis.RequiresAssemblyFilesAttribute.Url">
  3326. <summary>
  3327. Gets or sets an optional URL that contains more information about the member,
  3328. why it requires assembly files to be on disk, and what options a consumer has
  3329. to deal with it.
  3330. </summary>
  3331. </member>
  3332. <member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
  3333. <summary>
  3334. Indicates that the specified method requires the ability to generate new code at runtime,
  3335. for example through <see cref="N:System.Reflection"/>.
  3336. </summary>
  3337. <remarks>
  3338. This allows tools to understand which methods are unsafe to call when compiling ahead of time.
  3339. </remarks>
  3340. </member>
  3341. <member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
  3342. <summary>
  3343. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
  3344. with the specified message.
  3345. </summary>
  3346. <param name="message">
  3347. A message that contains information about the usage of dynamic code.
  3348. </param>
  3349. </member>
  3350. <member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
  3351. <summary>
  3352. Gets a message that contains information about the usage of dynamic code.
  3353. </summary>
  3354. </member>
  3355. <member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
  3356. <summary>
  3357. Gets or sets an optional URL that contains more information about the method,
  3358. why it requires dynamic code, and what options a consumer has to deal with it.
  3359. </summary>
  3360. </member>
  3361. <member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
  3362. <summary>
  3363. Indicates that the specified method requires dynamic access to code that is not referenced
  3364. statically, for example through <see cref="N:System.Reflection"/>.
  3365. </summary>
  3366. <remarks>
  3367. This allows tools to understand which methods are unsafe to call when removing unreferenced
  3368. code from an application.
  3369. </remarks>
  3370. </member>
  3371. <member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
  3372. <summary>
  3373. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
  3374. with the specified message.
  3375. </summary>
  3376. <param name="message">
  3377. A message that contains information about the usage of unreferenced code.
  3378. </param>
  3379. </member>
  3380. <member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
  3381. <summary>
  3382. Gets a message that contains information about the usage of unreferenced code.
  3383. </summary>
  3384. </member>
  3385. <member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
  3386. <summary>
  3387. Gets or sets an optional URL that contains more information about the method,
  3388. why it requires unreferenced code, and what options a consumer has to deal with it.
  3389. </summary>
  3390. </member>
  3391. <member name="T:System.Diagnostics.CodeAnalysis.SetsRequiredMembersAttribute">
  3392. <summary>
  3393. Specifies that this constructor sets all required members for the current type, and callers
  3394. do not need to set any required members themselves.
  3395. </summary>
  3396. </member>
  3397. <member name="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute">
  3398. <summary>Specifies the syntax used in a string.</summary>
  3399. </member>
  3400. <member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String)">
  3401. <summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.</summary>
  3402. <param name="syntax">The syntax identifier.</param>
  3403. </member>
  3404. <member name="M:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.#ctor(System.String,System.Object[])">
  3405. <summary>Initializes the <see cref="T:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute"/> with the identifier of the syntax used.</summary>
  3406. <param name="syntax">The syntax identifier.</param>
  3407. <param name="arguments">Optional arguments associated with the specific syntax employed.</param>
  3408. </member>
  3409. <member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Syntax">
  3410. <summary>Gets the identifier of the syntax used.</summary>
  3411. </member>
  3412. <member name="P:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Arguments">
  3413. <summary>Optional arguments associated with the specific syntax employed.</summary>
  3414. </member>
  3415. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.CompositeFormat">
  3416. <summary>The syntax identifier for strings containing composite formats for string formatting.</summary>
  3417. </member>
  3418. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateOnlyFormat">
  3419. <summary>The syntax identifier for strings containing date format specifiers.</summary>
  3420. </member>
  3421. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.DateTimeFormat">
  3422. <summary>The syntax identifier for strings containing date and time format specifiers.</summary>
  3423. </member>
  3424. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.EnumFormat">
  3425. <summary>The syntax identifier for strings containing <see cref="T:System.Enum"/> format specifiers.</summary>
  3426. </member>
  3427. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.GuidFormat">
  3428. <summary>The syntax identifier for strings containing <see cref="T:System.Guid"/> format specifiers.</summary>
  3429. </member>
  3430. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Json">
  3431. <summary>The syntax identifier for strings containing JavaScript Object Notation (JSON).</summary>
  3432. </member>
  3433. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.NumericFormat">
  3434. <summary>The syntax identifier for strings containing numeric format specifiers.</summary>
  3435. </member>
  3436. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Regex">
  3437. <summary>The syntax identifier for strings containing regular expressions.</summary>
  3438. </member>
  3439. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeOnlyFormat">
  3440. <summary>The syntax identifier for strings containing time format specifiers.</summary>
  3441. </member>
  3442. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.TimeSpanFormat">
  3443. <summary>The syntax identifier for strings containing <see cref="T:System.TimeSpan"/> format specifiers.</summary>
  3444. </member>
  3445. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Uri">
  3446. <summary>The syntax identifier for strings containing URIs.</summary>
  3447. </member>
  3448. <member name="F:System.Diagnostics.CodeAnalysis.StringSyntaxAttribute.Xml">
  3449. <summary>The syntax identifier for strings containing XML.</summary>
  3450. </member>
  3451. <member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
  3452. <summary>
  3453. Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
  3454. single code artifact.
  3455. </summary>
  3456. <remarks>
  3457. <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
  3458. <see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
  3459. <see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
  3460. </remarks>
  3461. </member>
  3462. <member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
  3463. <summary>
  3464. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
  3465. class, specifying the category of the tool and the identifier for an analysis rule.
  3466. </summary>
  3467. <param name="category">The category for the attribute.</param>
  3468. <param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
  3469. </member>
  3470. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
  3471. <summary>
  3472. Gets the category identifying the classification of the attribute.
  3473. </summary>
  3474. <remarks>
  3475. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
  3476. for which a message suppression attribute applies.
  3477. </remarks>
  3478. </member>
  3479. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
  3480. <summary>
  3481. Gets the identifier of the analysis tool rule to be suppressed.
  3482. </summary>
  3483. <remarks>
  3484. Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
  3485. properties form a unique check identifier.
  3486. </remarks>
  3487. </member>
  3488. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
  3489. <summary>
  3490. Gets or sets the scope of the code that is relevant for the attribute.
  3491. </summary>
  3492. <remarks>
  3493. The Scope property is an optional argument that specifies the metadata scope for which
  3494. the attribute is relevant.
  3495. </remarks>
  3496. </member>
  3497. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
  3498. <summary>
  3499. Gets or sets a fully qualified path that represents the target of the attribute.
  3500. </summary>
  3501. <remarks>
  3502. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
  3503. of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
  3504. Because it is fully qualified, it can be long, particularly for targets such as parameters.
  3505. The analysis tool user interface should be capable of automatically formatting the parameter.
  3506. </remarks>
  3507. </member>
  3508. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
  3509. <summary>
  3510. Gets or sets an optional argument expanding on exclusion criteria.
  3511. </summary>
  3512. <remarks>
  3513. The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
  3514. exclusion where the literal metadata target is not sufficiently precise. For example,
  3515. the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
  3516. and it may be desirable to suppress a violation against a statement in the method that will
  3517. give a rule violation, but not against all statements in the method.
  3518. </remarks>
  3519. </member>
  3520. <member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
  3521. <summary>
  3522. Gets or sets the justification for suppressing the code analysis message.
  3523. </summary>
  3524. </member>
  3525. <member name="T:System.Diagnostics.CodeAnalysis.UnscopedRefAttribute">
  3526. <summary>
  3527. Used to indicate a byref escapes and is not scoped.
  3528. </summary>
  3529. <remarks>
  3530. <para>
  3531. There are several cases where the C# compiler treats a <see langword="ref"/> as implicitly
  3532. <see langword="scoped"/> - where the compiler does not allow the <see langword="ref"/> to escape the method.
  3533. </para>
  3534. <para>
  3535. For example:
  3536. <list type="number">
  3537. <item><see langword="this"/> for <see langword="struct"/> instance methods.</item>
  3538. <item><see langword="ref"/> parameters that refer to <see langword="ref"/> <see langword="struct"/> types.</item>
  3539. <item><see langword="out"/> parameters.</item>
  3540. </list>
  3541. </para>
  3542. <para>
  3543. This attribute is used in those instances where the <see langword="ref"/> should be allowed to escape.
  3544. </para>
  3545. <para>
  3546. Applying this attribute, in any form, has impact on consumers of the applicable API. It is necessary for
  3547. API authors to understand the lifetime implications of applying this attribute and how it may impact their users.
  3548. </para>
  3549. </remarks>
  3550. </member>
  3551. <member name="M:System.Diagnostics.CodeAnalysis.UnscopedRefAttribute.#ctor">
  3552. <summary>
  3553. Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnscopedRefAttribute"/> class.
  3554. </summary>
  3555. </member>
  3556. <member name="T:System.Diagnostics.StackTraceHiddenAttribute">
  3557. <summary>
  3558. Types and Methods attributed with StackTraceHidden will be omitted from the stack trace text shown in StackTrace.ToString()
  3559. and Exception.StackTrace
  3560. </summary>
  3561. </member>
  3562. <member name="M:System.Diagnostics.StackTraceHiddenAttribute.#ctor">
  3563. <summary>
  3564. Initializes a new instance of the <see cref="T:System.Diagnostics.StackTraceHiddenAttribute"/> class.
  3565. </summary>
  3566. </member>
  3567. <member name="T:System.Index">
  3568. <summary>Represent a type can be used to index a collection either from the start or the end.</summary>
  3569. <remarks>
  3570. Index is used by the C# compiler to support the new index syntax
  3571. <code>
  3572. int[] someArray = new int[5] { 1, 2, 3, 4, 5 } ;
  3573. int lastElement = someArray[^1]; // lastElement = 5
  3574. </code>
  3575. </remarks>
  3576. </member>
  3577. <member name="M:System.Index.#ctor(System.Int32,System.Boolean)">
  3578. <summary>Construct an Index using a value and indicating if the index is from the start or from the end.</summary>
  3579. <param name="value">The index value. it has to be zero or positive number.</param>
  3580. <param name="fromEnd">Indicating if the index is from the start or from the end.</param>
  3581. <remarks>
  3582. If the Index constructed from the end, index value 1 means pointing at the last element and index value 0 means pointing at beyond last element.
  3583. </remarks>
  3584. </member>
  3585. <member name="P:System.Index.Start">
  3586. <summary>Create an Index pointing at first element.</summary>
  3587. </member>
  3588. <member name="P:System.Index.End">
  3589. <summary>Create an Index pointing at beyond last element.</summary>
  3590. </member>
  3591. <member name="M:System.Index.FromStart(System.Int32)">
  3592. <summary>Create an Index from the start at the position indicated by the value.</summary>
  3593. <param name="value">The index value from the start.</param>
  3594. </member>
  3595. <member name="M:System.Index.FromEnd(System.Int32)">
  3596. <summary>Create an Index from the end at the position indicated by the value.</summary>
  3597. <param name="value">The index value from the end.</param>
  3598. </member>
  3599. <member name="P:System.Index.Value">
  3600. <summary>Returns the index value.</summary>
  3601. </member>
  3602. <member name="P:System.Index.IsFromEnd">
  3603. <summary>Indicates whether the index is from the start or the end.</summary>
  3604. </member>
  3605. <member name="M:System.Index.GetOffset(System.Int32)">
  3606. <summary>Calculate the offset from the start using the giving collection length.</summary>
  3607. <param name="length">The length of the collection that the Index will be used with. length has to be a positive value</param>
  3608. <remarks>
  3609. For performance reason, we don't validate the input length parameter and the returned offset value against negative values.
  3610. we don't validate either the returned offset is greater than the input length.
  3611. It is expected Index will be used with collections which always have non negative length/count. If the returned offset is negative and
  3612. then used to index a collection will get out of range exception which will be same affect as the validation.
  3613. </remarks>
  3614. </member>
  3615. <member name="M:System.Index.Equals(System.Object)">
  3616. <summary>Indicates whether the current Index object is equal to another object of the same type.</summary>
  3617. <param name="value">An object to compare with this object</param>
  3618. </member>
  3619. <member name="M:System.Index.Equals(System.Index)">
  3620. <summary>Indicates whether the current Index object is equal to another Index object.</summary>
  3621. <param name="other">An object to compare with this object</param>
  3622. </member>
  3623. <member name="M:System.Index.GetHashCode">
  3624. <summary>Returns the hash code for this instance.</summary>
  3625. </member>
  3626. <member name="M:System.Index.op_Implicit(System.Int32)~System.Index">
  3627. <summary>Converts integer number to an Index.</summary>
  3628. </member>
  3629. <member name="M:System.Index.ToString">
  3630. <summary>Converts the value of the current Index object to its equivalent string representation.</summary>
  3631. </member>
  3632. <member name="T:System.Range">
  3633. <summary>Represent a range has start and end indexes.</summary>
  3634. <remarks>
  3635. Range is used by the C# compiler to support the range syntax.
  3636. <code>
  3637. int[] someArray = new int[5] { 1, 2, 3, 4, 5 };
  3638. int[] subArray1 = someArray[0..2]; // { 1, 2 }
  3639. int[] subArray2 = someArray[1..^0]; // { 2, 3, 4, 5 }
  3640. </code>
  3641. </remarks>
  3642. </member>
  3643. <member name="P:System.Range.Start">
  3644. <summary>Represent the inclusive start index of the Range.</summary>
  3645. </member>
  3646. <member name="P:System.Range.End">
  3647. <summary>Represent the exclusive end index of the Range.</summary>
  3648. </member>
  3649. <member name="M:System.Range.#ctor(System.Index,System.Index)">
  3650. <summary>Construct a Range object using the start and end indexes.</summary>
  3651. <param name="start">Represent the inclusive start index of the range.</param>
  3652. <param name="end">Represent the exclusive end index of the range.</param>
  3653. </member>
  3654. <member name="M:System.Range.Equals(System.Object)">
  3655. <summary>Indicates whether the current Range object is equal to another object of the same type.</summary>
  3656. <param name="value">An object to compare with this object</param>
  3657. </member>
  3658. <member name="M:System.Range.Equals(System.Range)">
  3659. <summary>Indicates whether the current Range object is equal to another Range object.</summary>
  3660. <param name="other">An object to compare with this object</param>
  3661. </member>
  3662. <member name="M:System.Range.GetHashCode">
  3663. <summary>Returns the hash code for this instance.</summary>
  3664. </member>
  3665. <member name="M:System.Range.ToString">
  3666. <summary>Converts the value of the current Range object to its equivalent string representation.</summary>
  3667. </member>
  3668. <member name="M:System.Range.StartAt(System.Index)">
  3669. <summary>Create a Range object starting from start index to the end of the collection.</summary>
  3670. </member>
  3671. <member name="M:System.Range.EndAt(System.Index)">
  3672. <summary>Create a Range object starting from first element in the collection to the end Index.</summary>
  3673. </member>
  3674. <member name="P:System.Range.All">
  3675. <summary>Create a Range object starting from first element to the end.</summary>
  3676. </member>
  3677. <member name="M:System.Range.GetOffsetAndLength(System.Int32)">
  3678. <summary>Calculate the start offset and length of range object using a collection length.</summary>
  3679. <param name="length">The length of the collection that the range will be used with. length has to be a positive value.</param>
  3680. <remarks>
  3681. For performance reason, we don't validate the input length parameter against negative values.
  3682. It is expected Range will be used with collections which always have non negative length/count.
  3683. We validate the range is inside the length scope though.
  3684. </remarks>
  3685. </member>
  3686. <member name="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute">
  3687. <summary>
  3688. An attribute that allows parameters to receive the expression of other parameters.
  3689. </summary>
  3690. </member>
  3691. <member name="M:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.#ctor(System.String)">
  3692. <summary>
  3693. Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute"/> class.
  3694. </summary>
  3695. <param name="parameterName">The condition parameter value.</param>
  3696. </member>
  3697. <member name="P:System.Runtime.CompilerServices.CallerArgumentExpressionAttribute.ParameterName">
  3698. <summary>
  3699. Gets the parameter name the expression is retrieved from.
  3700. </summary>
  3701. </member>
  3702. <member name="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute">
  3703. <summary>
  3704. Indicates that compiler support for a particular feature is required for the location where this attribute is applied.
  3705. </summary>
  3706. </member>
  3707. <member name="M:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.#ctor(System.String)">
  3708. <summary>
  3709. Creates a new instance of the <see cref="T:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute"/> type.
  3710. </summary>
  3711. <param name="featureName">The name of the feature to indicate.</param>
  3712. </member>
  3713. <member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName">
  3714. <summary>
  3715. The name of the compiler feature.
  3716. </summary>
  3717. </member>
  3718. <member name="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.IsOptional">
  3719. <summary>
  3720. If true, the compiler can choose to allow access to the location where this attribute is applied if it does not understand <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/>.
  3721. </summary>
  3722. </member>
  3723. <member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RefStructs">
  3724. <summary>
  3725. The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the ref structs C# feature.
  3726. </summary>
  3727. </member>
  3728. <member name="F:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.RequiredMembers">
  3729. <summary>
  3730. The <see cref="P:System.Runtime.CompilerServices.CompilerFeatureRequiredAttribute.FeatureName"/> used for the required members C# feature.
  3731. </summary>
  3732. </member>
  3733. <member name="T:System.Runtime.CompilerServices.DisableRuntimeMarshallingAttribute">
  3734. <summary>
  3735. Disables the built-in runtime managed/unmanaged marshalling subsystem for
  3736. P/Invokes, Delegate types, and unmanaged function pointer invocations.
  3737. </summary>
  3738. <remarks>
  3739. The built-in marshalling subsystem has some behaviors that cannot be changed due to
  3740. backward-compatibility requirements. This attribute allows disabling the built-in
  3741. subsystem and instead uses the following rules for P/Invokes, Delegates,
  3742. and unmanaged function pointer invocations:
  3743. - All value types that do not contain reference type fields recursively (<c>unmanaged</c> in C#) are blittable
  3744. - Value types that recursively have any fields that have <c>[StructLayout(LayoutKind.Auto)]</c> are disallowed from interop.
  3745. - All reference types are disallowed from usage in interop scenarios.
  3746. - SetLastError support in P/Invokes is disabled.
  3747. - varargs support is disabled.
  3748. - LCIDConversionAttribute support is disabled.
  3749. </remarks>
  3750. </member>
  3751. <member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute">
  3752. <summary>
  3753. Indicates which arguments to a method involving an interpolated string handler should be passed to that handler.
  3754. </summary>
  3755. </member>
  3756. <member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String)">
  3757. <summary>
  3758. Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class.
  3759. </summary>
  3760. <param name="argument">The name of the argument that should be passed to the handler.</param>
  3761. <remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
  3762. </member>
  3763. <member name="M:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.#ctor(System.String[])">
  3764. <summary>
  3765. Initializes a new instance of the <see cref="T:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute"/> class.
  3766. </summary>
  3767. <param name="arguments">The names of the arguments that should be passed to the handler.</param>
  3768. <remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
  3769. </member>
  3770. <member name="P:System.Runtime.CompilerServices.InterpolatedStringHandlerArgumentAttribute.Arguments">
  3771. <summary>
  3772. Gets the names of the arguments that should be passed to the handler.
  3773. </summary>
  3774. <remarks><see langword="null"/> may be used as the name of the receiver in an instance method.</remarks>
  3775. </member>
  3776. <member name="T:System.Runtime.CompilerServices.InterpolatedStringHandlerAttribute">
  3777. <summary>
  3778. Indicates the attributed type is to be used as an interpolated string handler.
  3779. </summary>
  3780. </member>
  3781. <member name="T:System.Runtime.CompilerServices.IsExternalInit">
  3782. <summary>
  3783. Reserved to be used by the compiler for tracking metadata.
  3784. This class should not be used by developers in source code.
  3785. </summary>
  3786. </member>
  3787. <member name="T:System.Runtime.CompilerServices.ModuleInitializerAttribute">
  3788. <summary>
  3789. Used to indicate to the compiler that a method should be called
  3790. in its containing module's initializer.
  3791. </summary>
  3792. <remarks>
  3793. When one or more valid methods
  3794. with this attribute are found in a compilation, the compiler will
  3795. emit a module initializer which calls each of the attributed methods.
  3796. Certain requirements are imposed on any method targeted with this attribute:
  3797. - The method must be `static`.
  3798. - The method must be an ordinary member method, as opposed to a property accessor, constructor, local function, etc.
  3799. - The method must be parameterless.
  3800. - The method must return `void`.
  3801. - The method must not be generic or be contained in a generic type.
  3802. - The method's effective accessibility must be `internal` or `public`.
  3803. The specification for module initializers in the .NET runtime can be found here:
  3804. https://github.com/dotnet/runtime/blob/main/docs/design/specs/Ecma-335-Augments.md#module-initializer
  3805. </remarks>
  3806. </member>
  3807. <member name="T:System.Runtime.CompilerServices.RequiredMemberAttribute">
  3808. <summary>
  3809. Specifies that a type has required members or that a member is required.
  3810. </summary>
  3811. </member>
  3812. <member name="T:System.Runtime.CompilerServices.SkipLocalsInitAttribute">
  3813. <summary>
  3814. Used to indicate to the compiler that the <c>.locals init</c> flag should not be set in method headers.
  3815. </summary>
  3816. </member>
  3817. <member name="T:System.Runtime.InteropServices.SuppressGCTransitionAttribute">
  3818. <summary>
  3819. An attribute used to indicate a GC transition should be skipped when making an unmanaged function call.
  3820. </summary>
  3821. <example>
  3822. Example of a valid use case. The Win32 `GetTickCount()` function is a small performance related function
  3823. that reads some global memory and returns the value. In this case, the GC transition overhead is significantly
  3824. more than the memory read.
  3825. <code>
  3826. using System;
  3827. using System.Runtime.InteropServices;
  3828. class Program
  3829. {
  3830. [DllImport("Kernel32")]
  3831. [SuppressGCTransition]
  3832. static extern int GetTickCount();
  3833. static void Main()
  3834. {
  3835. Console.WriteLine($"{GetTickCount()}");
  3836. }
  3837. }
  3838. </code>
  3839. </example>
  3840. <remarks>
  3841. This attribute is ignored if applied to a method without the <see cref="T:System.Runtime.InteropServices.DllImportAttribute"/>.
  3842. Forgoing this transition can yield benefits when the cost of the transition is more than the execution time
  3843. of the unmanaged function. However, avoiding this transition removes some of the guarantees the runtime
  3844. provides through a normal P/Invoke. When exiting the managed runtime to enter an unmanaged function the
  3845. GC must transition from Cooperative mode into Preemptive mode. Full details on these modes can be found at
  3846. https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/clr-code-guide.md#2.1.8.
  3847. Suppressing the GC transition is an advanced scenario and should not be done without fully understanding
  3848. potential consequences.
  3849. One of these consequences is an impact to Mixed-mode debugging (https://docs.microsoft.com/visualstudio/debugger/how-to-debug-in-mixed-mode).
  3850. During Mixed-mode debugging, it is not possible to step into or set breakpoints in a P/Invoke that
  3851. has been marked with this attribute. A workaround is to switch to native debugging and set a breakpoint in the native function.
  3852. In general, usage of this attribute is not recommended if debugging the P/Invoke is important, for example
  3853. stepping through the native code or diagnosing an exception thrown from the native code.
  3854. The runtime may load the native library for method marked with this attribute in advance before the method is called for the first time.
  3855. Usage of this attribute is not recommended for platform neutral libraries with conditional platform specific code.
  3856. The P/Invoke method that this attribute is applied to must have all of the following properties:
  3857. * Native function always executes for a trivial amount of time (less than 1 microsecond).
  3858. * Native function does not perform a blocking syscall (e.g. any type of I/O).
  3859. * Native function does not call back into the runtime (e.g. Reverse P/Invoke).
  3860. * Native function does not throw exceptions.
  3861. * Native function does not manipulate locks or other concurrency primitives.
  3862. Consequences of invalid uses of this attribute:
  3863. * GC starvation.
  3864. * Immediate runtime termination.
  3865. * Data corruption.
  3866. </remarks>
  3867. </member>
  3868. <member name="T:System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute">
  3869. <summary>
  3870. Any method marked with <see cref="T:System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute" /> can be directly called from
  3871. native code. The function token can be loaded to a local variable using the <see href="https://docs.microsoft.com/dotnet/csharp/language-reference/operators/pointer-related-operators#address-of-operator-">address-of</see> operator
  3872. in C# and passed as a callback to a native method.
  3873. </summary>
  3874. <remarks>
  3875. Methods marked with this attribute have the following restrictions:
  3876. * Method must be marked "static".
  3877. * Must not be called from managed code.
  3878. * Must only have <see href="https://docs.microsoft.com/dotnet/framework/interop/blittable-and-non-blittable-types">blittable</see> arguments.
  3879. </remarks>
  3880. </member>
  3881. <member name="F:System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute.CallConvs">
  3882. <summary>
  3883. Optional. If omitted, the runtime will use the default platform calling convention.
  3884. </summary>
  3885. <remarks>
  3886. Supplied types must be from the official "System.Runtime.CompilerServices" namespace and
  3887. be of the form "CallConvXXX".
  3888. </remarks>
  3889. </member>
  3890. <member name="F:System.Runtime.InteropServices.UnmanagedCallersOnlyAttribute.EntryPoint">
  3891. <summary>
  3892. Optional. If omitted, no named export is emitted during compilation.
  3893. </summary>
  3894. </member>
  3895. <member name="T:System.Runtime.Versioning.ObsoletedOSPlatformAttribute">
  3896. <summary>
  3897. Marks APIs that were obsoleted in a given operating system version.
  3898. </summary>
  3899. <remarks>
  3900. Primarily used by OS bindings to indicate APIs that should not be used anymore.
  3901. </remarks>
  3902. </member>
  3903. <member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor">
  3904. <summary>
  3905. Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class.
  3906. </summary>
  3907. </member>
  3908. <member name="M:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.#ctor(System.String)">
  3909. <summary>
  3910. Initializes a new instance of the <see cref="T:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute"/> class with the specified message.
  3911. </summary>
  3912. <param name="message">An optional message associated with this attribute instance.</param>
  3913. </member>
  3914. <member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Message">
  3915. <summary>
  3916. Returns the optional message associated with this attribute instance.
  3917. </summary>
  3918. </member>
  3919. <member name="P:System.Runtime.Versioning.RequiresPreviewFeaturesAttribute.Url">
  3920. <summary>
  3921. Returns the optional URL associated with this attribute instance.
  3922. </summary>
  3923. </member>
  3924. <member name="T:System.Runtime.Versioning.SupportedOSPlatformAttribute">
  3925. <summary>
  3926. Records the operating system (and minimum version) that supports an API. Multiple attributes can be
  3927. applied to indicate support on multiple operating systems.
  3928. </summary>
  3929. <remarks>
  3930. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformAttribute" />
  3931. or use guards to prevent calls to APIs on unsupported operating systems.
  3932. A given platform should only be specified once.
  3933. </remarks>
  3934. </member>
  3935. <member name="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute">
  3936. <summary>
  3937. Annotates a custom guard field, property or method with a supported platform name and optional version.
  3938. Multiple attributes can be applied to indicate guard for multiple supported platforms.
  3939. </summary>
  3940. <remarks>
  3941. Callers can apply a <see cref="T:System.Runtime.Versioning.SupportedOSPlatformGuardAttribute" /> to a field, property or method
  3942. and use that field, property or method in a conditional or assert statements in order to safely call platform specific APIs.
  3943. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  3944. </remarks>
  3945. </member>
  3946. <member name="T:System.Runtime.Versioning.TargetPlatformAttribute">
  3947. <summary>
  3948. Records the platform that the project targeted.
  3949. </summary>
  3950. </member>
  3951. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformAttribute">
  3952. <summary>
  3953. Marks APIs that were removed in a given operating system version.
  3954. </summary>
  3955. <remarks>
  3956. Primarily used by OS bindings to indicate APIs that are only available in
  3957. earlier versions.
  3958. </remarks>
  3959. </member>
  3960. <member name="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute">
  3961. <summary>
  3962. Annotates the custom guard field, property or method with an unsupported platform name and optional version.
  3963. Multiple attributes can be applied to indicate guard for multiple unsupported platforms.
  3964. </summary>
  3965. <remarks>
  3966. Callers can apply a <see cref="T:System.Runtime.Versioning.UnsupportedOSPlatformGuardAttribute" /> to a field, property or method
  3967. and use that field, property or method in a conditional or assert statements as a guard to safely call APIs unsupported on those platforms.
  3968. The type of the field or property should be boolean, the method return type should be boolean in order to be used as platform guard.
  3969. </remarks>
  3970. </member>
  3971. <member name="T:System.Threading.Tasks.TaskToAsyncResult">
  3972. <summary>
  3973. Provides methods for using <see cref="T:System.Threading.Tasks.Task"/> to implement the Asynchronous Programming Model
  3974. pattern based on "Begin" and "End" methods.
  3975. </summary>
  3976. </member>
  3977. <member name="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)">
  3978. <summary>Creates a new <see cref="T:System.IAsyncResult"/> from the specified <see cref="T:System.Threading.Tasks.Task"/>, optionally invoking <paramref name="callback"/> when the task has completed.</summary>
  3979. <param name="task">The <see cref="T:System.Threading.Tasks.Task"/> to be wrapped in an <see cref="T:System.IAsyncResult"/>.</param>
  3980. <param name="callback">The callback to be invoked upon <paramref name="task"/>'s completion. If <see langword="null"/>, no callback will be invoked.</param>
  3981. <param name="state">The state to be stored in the <see cref="T:System.IAsyncResult"/>.</param>
  3982. <returns>An <see cref="T:System.IAsyncResult"/> to represent the task's asynchronous operation. This instance will also be passed to <paramref name="callback"/> when it's invoked.</returns>
  3983. <exception cref="T:System.ArgumentNullException"><paramref name="task"/> is null.</exception>
  3984. <remarks>
  3985. In conjunction with the <see cref="M:System.Threading.Tasks.TaskToAsyncResult.End(System.IAsyncResult)"/> or <see cref="M:System.Threading.Tasks.TaskToAsyncResult.End``1(System.IAsyncResult)"/> methods, this method may be used
  3986. to implement the Begin/End pattern (also known as the Asynchronous Programming Model pattern, or APM). It is recommended to not expose this pattern
  3987. in new code; the methods on <see cref="T:System.Threading.Tasks.TaskToAsyncResult"/> are intended only to help implement such Begin/End methods when they must be exposed, for example
  3988. because a base class provides virtual methods for the pattern, or when they've already been exposed and must remain for compatibility. These methods enable
  3989. implementing all of the core asynchronous logic via <see cref="T:System.Threading.Tasks.Task"/>s and then easily implementing Begin/End methods around that functionality.
  3990. </remarks>
  3991. </member>
  3992. <member name="M:System.Threading.Tasks.TaskToAsyncResult.End(System.IAsyncResult)">
  3993. <summary>Waits for the <see cref="T:System.Threading.Tasks.Task"/> wrapped by the <see cref="T:System.IAsyncResult"/> returned by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/> to complete.</summary>
  3994. <param name="asyncResult">The <see cref="T:System.IAsyncResult"/> for which to wait.</param>
  3995. <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult"/> is null.</exception>
  3996. <exception cref="T:System.ArgumentException"><paramref name="asyncResult"/> was not produced by a call to <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/>.</exception>
  3997. <remarks>This will propagate any exception stored in the wrapped <see cref="T:System.Threading.Tasks.Task"/>.</remarks>
  3998. </member>
  3999. <member name="M:System.Threading.Tasks.TaskToAsyncResult.End``1(System.IAsyncResult)">
  4000. <summary>Waits for the <see cref="T:System.Threading.Tasks.Task`1"/> wrapped by the <see cref="T:System.IAsyncResult"/> returned by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/> to complete.</summary>
  4001. <param name="asyncResult">The <see cref="T:System.IAsyncResult"/> for which to wait.</param>
  4002. <returns>The result of the <see cref="T:System.Threading.Tasks.Task`1"/> wrapped by the <see cref="T:System.IAsyncResult"/>.</returns>
  4003. <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult"/> is null.</exception>
  4004. <exception cref="T:System.ArgumentException"><paramref name="asyncResult"/> was not produced by a call to <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/>.</exception>
  4005. <remarks>This will propagate any exception stored in the wrapped <see cref="T:System.Threading.Tasks.Task`1"/>.</remarks>
  4006. </member>
  4007. <member name="M:System.Threading.Tasks.TaskToAsyncResult.Unwrap(System.IAsyncResult)">
  4008. <summary>Extracts the underlying <see cref="T:System.Threading.Tasks.Task"/> from an <see cref="T:System.IAsyncResult"/> created by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/>.</summary>
  4009. <param name="asyncResult">The <see cref="T:System.IAsyncResult"/> created by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/>.</param>
  4010. <returns>The <see cref="T:System.Threading.Tasks.Task"/> wrapped by the <see cref="T:System.IAsyncResult"/>.</returns>
  4011. <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult"/> is null.</exception>
  4012. <exception cref="T:System.ArgumentException"><paramref name="asyncResult"/> was not produced by a call to <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/>.</exception>
  4013. </member>
  4014. <member name="M:System.Threading.Tasks.TaskToAsyncResult.Unwrap``1(System.IAsyncResult)">
  4015. <summary>Extracts the underlying <see cref="T:System.Threading.Tasks.Task`1"/> from an <see cref="T:System.IAsyncResult"/> created by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/>.</summary>
  4016. <param name="asyncResult">The <see cref="T:System.IAsyncResult"/> created by <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/>.</param>
  4017. <returns>The <see cref="T:System.Threading.Tasks.Task`1"/> wrapped by the <see cref="T:System.IAsyncResult"/>.</returns>
  4018. <exception cref="T:System.ArgumentNullException"><paramref name="asyncResult"/> is null.</exception>
  4019. <exception cref="T:System.ArgumentException">
  4020. <paramref name="asyncResult"/> was not produced by a call to <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/>,
  4021. or the <see cref="T:System.Threading.Tasks.Task`1"/> provided to <see cref="M:System.Threading.Tasks.TaskToAsyncResult.Begin(System.Threading.Tasks.Task,System.AsyncCallback,System.Object)"/> was used a generic type parameter
  4022. that's different from the <typeparamref name="TResult"/> supplied to this call.
  4023. </exception>
  4024. </member>
  4025. <member name="T:System.Threading.Tasks.TaskToAsyncResult.TaskAsyncResult">
  4026. <summary>Provides a simple <see cref="T:System.IAsyncResult"/> that wraps a <see cref="T:System.Threading.Tasks.Task"/>.</summary>
  4027. <remarks>
  4028. We could use the Task as the IAsyncResult if the Task's AsyncState is the same as the object state,
  4029. but that's very rare, in particular in a situation where someone cares about allocation, and always
  4030. using TaskAsyncResult simplifies things and enables additional optimizations.
  4031. </remarks>
  4032. </member>
  4033. <member name="F:System.Threading.Tasks.TaskToAsyncResult.TaskAsyncResult._task">
  4034. <summary>The wrapped Task.</summary>
  4035. </member>
  4036. <member name="F:System.Threading.Tasks.TaskToAsyncResult.TaskAsyncResult._callback">
  4037. <summary>Callback to invoke when the wrapped task completes.</summary>
  4038. </member>
  4039. <member name="M:System.Threading.Tasks.TaskToAsyncResult.TaskAsyncResult.#ctor(System.Threading.Tasks.Task,System.Object,System.AsyncCallback)">
  4040. <summary>Initializes the IAsyncResult with the Task to wrap and the associated object state.</summary>
  4041. <param name="task">The Task to wrap.</param>
  4042. <param name="state">The new AsyncState value.</param>
  4043. <param name="callback">Callback to invoke when the wrapped task completes.</param>
  4044. </member>
  4045. <member name="P:System.Threading.Tasks.TaskToAsyncResult.TaskAsyncResult.AsyncState">
  4046. <inheritdoc/>
  4047. </member>
  4048. <member name="P:System.Threading.Tasks.TaskToAsyncResult.TaskAsyncResult.CompletedSynchronously">
  4049. <inheritdoc/>
  4050. </member>
  4051. <member name="P:System.Threading.Tasks.TaskToAsyncResult.TaskAsyncResult.IsCompleted">
  4052. <inheritdoc/>
  4053. </member>
  4054. <member name="P:System.Threading.Tasks.TaskToAsyncResult.TaskAsyncResult.AsyncWaitHandle">
  4055. <inheritdoc/>
  4056. </member>
  4057. </members>
  4058. </doc>